執筆のポイント
製品の解説と操作手順の表し方


機能および構成の解説

 

取扱いマニュアルあるいはシステム操作マニュアルでは,序盤の章で「製品あるいはシステムがいかなる構成であるのか」あるいは「搭載されている機能がいかなるものか」など の読者が使うための知識を段落と図・表あるいは箇条書きで解説します.


見出しに対応した「主文−補足文」構成の段落

先のコーナーで述べたように, 「見出し(主題)に対応した主文(要点)を段落の最初に置く」が要点が明確な段落の基本です.あわせて,補足文で要点を補足するとともに,必要に応じて図・表,箇条書きあるいは注記で補足します.

主文と補足文によって「メーカの論理で開発された製品(機能,構成)」を「読者が知りうるもっとも適切な用語(一般用語すぎず,かつ必要以上に専門用語ではない用語)」で解説します.


構成」を要点にした段落の例

見出し名が「製品の構成」の場合には「製品は,AとBで構成されています」とすれば,読者がAとBが何であるか知らなくとも「全体が二つの要素で構成されている」という要点が伝わります,後はAとBがそれぞれ何であるか補足文で述べれば,主文と補足文が関係付けられます.


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

山之内総合研究所の出張開催セミナー

セミナー/コンサルティングFAQセミナー基本料金[抜粋PDF版]



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