18-2  システム操作マニュアル:見出し構成の考え方-操作モードを選んで使う製品-

 システム操作マニュアルに限らず、マニュアルを作成する際は見出し構成を十分に検討してから執筆に進む必要があります。その際に大切なのは、不要に見出しを細分せずに「読者が知りたい事項」あるいは「読者が知るべき事項」を上位の見出しに置くことです。

「見出しを不要に細分しない構成」  ・・・ 必要な事項が見つけやすい見出し構成

 今回は、計測制御システムや監視システムといった「状況あるいは目的に応じて操作モードを選んで結果を得る製品」のマニュアルを想定して、その見出し構成の考え方を述べてゆきます。

1.     システム操作マニュアルへの取り組み方

2.     マニュアルの見出し構成

3.     構成イメージ」の書き出し

4.     陥りやすい事例:「順序性」と「並列性」の取り違え

5.     仮の章番号」の付与と「ページ数」の見積もり

6.     見出し構成の調整

7.     「何を達成するのか」が明確な見出し名

まとめ

後 記

© Yamanouchi Takaaki 2024

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

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

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

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

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

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

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

コメント

このブログの人気の投稿

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

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

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