マニュアル作成のポイント
「わかりやすいマニュアル」とテクニカルライティング


当サイトのポイント

マニュアルテクニカルライティング

   

テクニカルライティングには、「わかりやすいマニュアル」を具体化するさまざまな手法があります。同時に、これらの手法はマニュアルを作成する際に執筆者が遭遇するさまざまな課題の解決策でもあります。


「わかりやすい」を具体化する手法

前述のように、マニュアルのわかりやすさは主に「“見通しがよい”見出し構成」、「要点が明確な段落(手順を含む)」に加えて「視覚的・構造的な表現」、「読者の視点を主体にした文体」によって構成されます。テクニカルライティングには、これらを具体化するさまざな手法が事例とともに体系化されています。


マニュアル作成に有効な手法の例−「直列構成と並列構成の組合せ」−

“見通しがよい”見出し構成につながる手法の一つとして、ここでは「直列構成と並列構成の組合せ」を取り上げます。

「原理」と「手法」の確認

同じ見出しランクの見出しの構成には、「直列(順序性がある)」構成と「並列(独立性がある)」構成の二通りがあります。いずれも厳密な分類ではなく、見出し間の関係性と理解してください。

マニュアルに限らず文書の見出し構成を検討する際には、「直列」構成、「並列」構成に加えて、両方を組み合わせた構成を使い分けるのがポイントです。

陥りやすい事例の分析

「第1節 概要(総論)」→「第2節 各種の操作」の直列的な構成にすると、「第2節 各種の操作」の下位に項見出しとして“各種”の操作が並列に構成される結果になります。

「手法」の導入

「直列」構成と「並列」構成を組み合わせて項見出しを節見出しに繰り上げると、読者にとって「知りたい事項」である操作方法が上位となり、“見通しがよい (上位の見出しで見つかる)”見出し構成になります。

テクニカルライティングには、上記以外に複雑な見出し構成をわかりやすくするさまざまな手法があります。また、文章・段落をまとめるあるいは図解化する際に有効な手法もあります。


次ページに進む(ボタンをクリックしてください


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