本書は、業務システムに特化したユーザーマニュアル作成の解説書です。ユーザーマニュアルは、完成したシステムを利用者に不便なく使ってもらうための手引きです。その出来が悪いと、利用者が不満を抱くだけでなく、操作ミスが続発して後々のメンテナンスにかかるコスト（費用と労力）が膨大になります。ユーザーマニュアルは、システム開発の技術力が高いだけでは作れません。作成のためのしかるべきノウハウを持っていないと、途中で挫折したり、まったく役に立たないものができてしまったりします。では、ユーザーマニュアルを作るうえで必要なノウハウとは何でしょうか。そのすべての答えが本書の中にあります。
第1章 マニュアル作成の「間違った常識」
1-1 常識の誤り マニュアル作成は目次構成の検討から始める
1-2 常識の誤りマニュアルは読者別に分冊にする
1-3 常識の誤り 書き始める前に文章の組み立てを行う
1-4 常識の誤り マニュアルでは操作と結果を分けて書く
1-5 常識の誤り わかりやすいマニュアルを書ける人は、文章の上手な人
1-6 常識の誤り 正しい日本語文法の知識は必須である
1-7 常識の誤り マニュアルには索引は必須である
第2章 マニュアルの企画はこう進める
2-1 内容1 目的と特徴を理解する
2-2 内容2 業務の手順を整理して理解する
2-3 内容3 仕様を整理して理解する
2-4 内容4 基本操作の手順説明を作成する
2-5 内容5 導入前後で業務が変わるところを探し出す
2-6 内容6 期待に応えられないところを探し出す
2-7 構成1 記載項目をリストにする
2-8 構成2 記載項目リストを整理する
2-9 構成3 導入マニュアルとして仕上げる
2-10 構成4 運用マニュアルとして仕上げる
2-11 構成5 リファレンスマニュアルとして仕上げる
2-12 構成6 操作支援マニュアルや操作ヘルプとして仕上げる
2-13 紙面1 「読んで理解」ではなく「見て理解」を目指す
2-14 紙面2 対象者限定情報を視覚的に示す
2-15 紙面3 視覚的に注意を喚起する
2-16 確認1 情報の過不足を再確認する
2-17 確認2 企画内容を評価する
第3章 マニュアルの文章はこう書く
3-1 情報をわかりやすく伝える
3-2 簡潔に書く
3-3 読者の負担を軽くする
3-4 誤解を招かないための文章テクニック
3-5 マニュアルの主な要素を実践的に書く
第4章 マニュアルや仕様書をわかりやすくするビジュアル表現
4-1 ビジュアル表現の利点を知ろう
4-2 論理の図解方法を知ろう
4-3 情報のグループを視覚的に伝える
4-4 注意を喚起する
4-5 検索性を高める
4-6 読みやすくデザインする
第5章 マニュアルの内容・表現の校正はこう進める
5-1 校正こそが品質を高める
5-2 技術的正確性を確認する
5-3 読みやすさを確認する
5-4 文章の品質・品格を確認する
第6章 マニュアルの保守管理はこうする
6-1 電子化のポイントを知る
6-2 アプリケーションファイルを管理する
6-3 ファイル名はこう付ける
6-4 改訂情報を付与して世代管理する
6-5 属性情報を付与して検索効率を高める
6-6 セキュリティに配慮する
6-7 関連する法令を理解する
第7章 部品化と構造化で効率アップ
7-1 効率アップの肝は構造化と部品化にある
7-2 管理しやすくするために構造化する
7-3 わかりやすくするために構造化する
7-4 構造化の基本を知ろう
7-5 データ流用、再利用のコツはこれだ
7-6 事例：構造化して検索性を高める
7-7 文書の部品化が必要とされる背景を知る
7-8 部品化の基本を知ろう
7-9 事例：部品化して作成効率を高める
subuta さん
2017-06-07
校正記号の使い方、Word文書の部品化など、マニュアル作成に関わる話を幅広く取り上げている。そのためか、実際の記述例があまり見当たらなかった。
そうとめ さん
2012-04-23
マニュアルを書くにも、読者（ペルソナ）を絞り込みが役に立つと書いてありました。ペルソナが適切に設定されていれば、「この説明は自分の立場や業務内容にマッチしている」と感じることができ、より具体的に内容を把握することができるようになる。 http://blog.goo.ne.jp/aki-nagi-kae/e/981e5373cb9ce73943a6b34d5cadcefd
2024年にSEshopで人気だった本を20冊ご紹介！IT技術、生成AI活用、マネジメント本など
翔泳社のプログラミング書籍の中から、入門・初級者向けの書籍をピックアップ！
【エンジニア必携特集】開発現場で使える！ITエンジニアの業務に役立つ書籍を一挙ご紹介
ライティングのスキルアップにおすすめの本。Webライティングやコピーライティングなど
毎日をもっと楽しく、充実させる手帳・ノートの活用術書をご紹介
第二種電気工事士、電験3種など、電気工事技術者関連の資格参考書はこちら
お気に入りに登録すると、気になる商品ページにすばやくアクセスできます。ご利用にはログインが必要です。
