18-5 システム操作マニュアル：「操作手順」の書式

　システム操作マニュアルに限らず、操作手順の書式には満たすべき要件があります。

l  　操作手順の各項に読者の目が向かなくてはならない。

l  　操作の指示に付帯する事項も、見落とされないようにしなくてはならない。

l  　技術文書としての基本的な体裁を整えていなくてはならない。

三つの要件を満たすのはたいへんなように思えますが、すべてワープロで可能です。見出しで改ページにするにしても文字の大きさを決めるにしても、大切なのはそれにどのような意味があるかを理解することです。一方で、基本的な要件を満たせば、それ以上に“凝った書式”にする必要もありません。

今回は、上述の要件に沿った書式の選び方を中心にして述べてゆきます。あわせて、原則から逸脱して使いづらくなった事例をあげてその直し方を解説します。

1.     節見出しの書式

2.     「操作手順を述べる項目」の書式

3.     「操作手順」の書式

4.     副本文および注記の添え方

5.     図の添え方

6.     操作手順が複数のページになる場合の工夫

7.     陥りやすい事例：原則から逸脱した書式

8.     陥りやすい事例：注記・副本文の後置き

9.     手順の項目数が多いマニュアルの工夫

10. 　 陥りやすい事例：告知と指示の関係が曖昧な「入れ子式」

まとめ

後　記

© Yamanouchi Takaaki 2024

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

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

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

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

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

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

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