18-3  システム操作マニュアル:「操作手順を述べる項目」を表す際の基本

 操作手順を述べる項目は、「解説の基本単位」と位置づけて第2階層の見出しである「節」に置きます。

章:文書の大枠 - 節:解説の基本単位 - 項:節の小分け -(目:限定的な小分け)

                        操作手順を述べる項目 

                        ・・・ ユーザーが一つの目的を達成するのに必要な「知識と手順」をまとめた項目

 操作手順(以下、「手順」と略記)を表す際は、手順の前に「導入段落」を置きます。

 今回は、「節見出し-導入段落-手順」の構成を基本にしつつ節を項に分けて手順を述べる応用的な構成を解説します。見出し構成の考え方および手順の表し方は別の回で解説します。

1.     「手順を述べる項目」の基本形

2.     陥りやすい事例:ユーザーの動機づけにならない導入段落

3.     章の導入段落

4.     「節見出し-導入段落-手順」の構成では表せない操作

5.     条件ごとの手順がある場合の工夫

6.     派生的な操作がある場合の工夫

7.     陥りやすい事例: 原則から逸脱した節・項構成

まとめ

後 記

© Yamanouchi Takaaki 2024

[注]今回のテーマは他の回と関連するため、以前に解説した内容と重複する箇所があります。

ブログの本文は、下記のPDFファイルで閲覧できます。

本文のPDFファイルA4判・全20ページ)

【重要】 PDFファイルの表示に伴うトラブルへの責任は、一切負いません。

 ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文をPDFファイルにして概要・目次に添付しました。HTML形式ではワープロ文書の表し方を解説しきれないというのがその理由です。

l PDFファイルは、5MB以内です。使用する閲覧ソフトウェアによって表示の細部が若干異なる場合があります。

l   PDFファイルの利用は、閲覧のみです。共有やダウンロードなどのご要望には応じかねます。

コメント

このブログの人気の投稿

1-1  「見出し構成」とは

1-2  見出し構成の「原則」

テクニカルライティングの効果:文書品質の向上と作成時間の短縮