18-1  システム操作マニュアル:見出し構成の考え方-段階的に作業を進める使い方の製品-

 システムあるいはソフトウェアの操作を表すマニュアルでは、見出し名が画面やメニューなどの名称になりがちです。その結果、「製品をどのように使ってゆくのか」といった「ユーザーの視点」からそれて、マニュアルの内容が機能などの説明に偏った「メーカーの視点」に陥りやすくなります。

メーカーの視点」に陥ったシステム操作マニュアル

  ・・・ 「製品がどのように作られているか」の説明になりやすい。
            ユーザーからすると、「製品の説明をどのように使い方に結びつけるのか」を考えなくてはならない。

ユーザーに役立つシステム操作マニュアルであるためには、「ユーザーは製品にどのように向き合うのか」を十分に考えて見出しを構成する必要があります。

今回は、「段階的に作業を進める製品」のシステム操作マニュアルを取り上げて、その見出し構成の考え方を述べてゆきます。「操作モードや機能などを選んで使う製品」の見出し構成は、別の回で解説します。

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

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

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

4.     読者から「マニュアルの構成がわかりづらい」と指摘される原因

5.     下位の見出しを考慮した「仮の章構成」の検討

6.     執筆用の章構成の書き出し

7.     節見出し名の調整

まとめ

後 記

© Yamanouchi Takaaki 2024

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

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

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

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

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

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

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

コメント

このブログの人気の投稿

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

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

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