「わかりやすいマニュアルとは何か」をユーザ視点で考えれば、マニュアル作成の方針や進め方が見えてきます。	下図はサンプル（抜粋・縮小版）です。
		「わかりやすいマニュアル」とテクニカルライティング 「わかりやすいマニュアルの要件」と「テクニカルライティングとは」を解説します。あわせて、当サイトの第1部から第9部をレビューします。
		マニュアル作成の進め方 マニュアル作成の手順を「書式の準備」、「見出し構成の検討」、「執筆と見直し」の三つのステップで解説します。

トップに戻る

		マニュアル作成は、見出し構成と見出し名の検討から始まります。複雑な見出し構成や曖昧な見出し名は、必要な事項が探しにくく取扱い方法も不明確なマニュアルの原因になります。
		第1部　見出し構成と見出し名の考え方 “見通しがよい”見出し構成と“執筆につながる”見出し名の考え方を解説します。あわせて、電子マニュアル（Webマニュアル）の見出し構成の考え方を補足します。
		第2部　段落構成の考え方と箇条書き、図・表、注記の使い方 要点が明確な段落のまとめ方と箇条書き、図・表あるいは注記の有効な使い方を解説します。
		第3部　製品の解説と操作手順の表し方 製品（およびシステム）の機能・構成の解説とともに操作手順と注意指示の表し方の基本とポイントを解説します。

トップに戻る

---

		「何か読者の理解を損ねているか」を整理すれば、「どのように見直せばよいのか」が明らかになります。
		第4部　　陥りやすい技術表現の見直し方 技術文書の文章で陥りやすい表現（曖昧表現、冗長表現、技術文書になじまない表現）の事例と見直し方を抜粋で解説します。 あわせて、句読点、記号を使う際の基本と留意事項を解説します。
		第5部　誤解・違和感につながる文の見直し方 二重解釈につながる文あるいは「わかりづらい」につながる文（例：主語と述語の対応が曖昧な文）の原因とその見直し方を解説します。

 

トップに戻る

---

		図解の活用や文書レイアウトの工夫は、「見やすさ＝理解のしやすさ」につながります。
		第6部　マニュアルに適した図解の手法  「見る」と「読む」を組み合わせた効果的な図解の手法を解説します。
		第7部　マニュアルに適した文書レイアウトのポイント 見やすくかつワープロで可能な文書レイアウトのポイントを解説します。

トップに戻る

---

		マニュアルの品質を高めるには、文書書式と用語を適切に選ぶ必要があります
		第8部　文書書式の選び方と執筆のルール化 読みやすくかつ適切な文書書式の選び方と執筆に際してこれらをルールにまとめる方法を解説します。
		第9部　用字用語の選び方と用例 「漢字書きとひらがな書きの使い分け」、「送り仮名の付け方」、「外来語のカタカナ表記」など執筆の際の基本となる事項とその用例を解説します。

 

トップに戻る

		テクニカルライティングの目標は、「読者の理解の獲得」と「文書作成の効率化」の両立です。テクニカルライティングは、執筆者の皆さんの文書作成を否定するものではありません。皆さんがおもちの知識や手法の再構成であり補完です。
		テクニカルライティングの効果 文書品質の向上と文書作成時間の短縮 　−「書く」から導かれる知的生産力− 企業にとっての文書作成の重要性とテクニカルライティングの効果を解説します。 テクニカルライティングをとおして文書作成の進め方を見直すと、文書作成の効率化と文書品質の向上につながります。 当コーナーはPDFファイル版でもご覧いただけます。
		技術文書の「書き方」 　−共通のポイントと各種文書への応用− 「ワープロの手が進まない」の打開につながるテクニカルライティングの基本手法を解説します。さらに、これを各種の技術文書（報告書、製品解説・マニュアルあるいは機能仕様書など）の書き方に展開します。

トップに戻る

		テクニカルライティングの手法は、ワープロ文書のみならずプレゼンや電子文書にも有効です。
		わかりやすいプレゼン資料の作成手法 技術文書もプレゼンも、要点を的確に伝えることがなによりも重要です。 「聴き手の課題」を的確にとらえ「技術に裏付けられた解決策」を提案するプレゼン資料の構成法と表現手法を解説します。
		電子マニュアルの考え方と タブレット端末で読める電子版図解マニュアルの作り方 マニュアルを電子化する際のポイントを解説します。また、「タブレット端末で読める」をテーマに文書スタイルの電子マニュアルの作り方を概説します。さらには、「真に印刷文書に置き換わり、かつマニュアルならではのインタラクティビティを備えた動画マニュアル」の具体像を論じます。

トップに戻る

実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明／有限会社　山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.

　takaaki@yamanouchi-yri.com