製品解説およびマニュアルの書き方
− 「執筆者の視点」ではなく，「読者の視点」で要点を述べる−

「機能仕様書」と「製品解説およびマニュアル」の 文体の違い

先述のように機能仕様書の「主たる視点」は，「（製品をともに開発する）私たち」です．対して，製品解説およびマニュアルの「主たる視点」は，「（製品のユーザである）あなた」です．

• 製品解説およびマニュアルを「文書の仮想空間」で考えると，製品がユーザの前にあり執筆者がユーザの傍らで製品とその扱い方を解説している状況と言えます．

製品解説・マニュアルは，「ユーザにとっていかなる製品か」，「いかに操作するか」を主旨にした文書です．したがって，製品の動作を「（ユーザであるあなたによる）操作の結果」として表すのが一般的です．

• 機能仕様書では，製品の動作を「ある条件（仮想のユーザの操作あるいは事象の発生）による定性動作（製品は-を-する）」として表します．対して，製品解説およびマニュアルでは読者であるユーザが製品を扱う 状況を想定しています．したがって，「（ユーザであるあなたの）操作によって，結果が表示される／表れる」あるいは「（あなたは）目的を達成できる」を基本の文体にして表すのが適当です．

まず機能仕様書があり，機能仕様書に沿って製品が開発され，さらに開発された製品とともに製品解説・マニュアルは作成されます．機能仕様書をベースにして製品解説およびマニュアルを作成するのは自然な進め方ですが，機能仕様書 をベースにしていても｢主たる視点」が異なります．製品解説 およびマニュアルを作成する際は，読者を中心にした見出し構成と文体に再構築する必要があります．

• 先のセクションでも述べましたが，面倒と思われる必要はありません．もともと製品はユーザの要望に答えるべく開発されているはずです．事実を変えるのではなく，まさに「視点」を変えるだけです．ユーザから製品解説 あるいはマニュアルに対する改善要求がでた場合，最初にすべきは「図解にする」ではなく「メーカの視点に陥っていないか見直す」です．図解は，「読者の視点」による文体・段落構成の延長線上にある手法です．形式だけの図解では，図解化に伴う執筆者の労力に見合う読者の満足は得られません．

「主たる視点」の活用形から導かれる「隠れた導入語」

主たる視点を「（ユーザである）あなた」に置いて，「あなたにとって」いかなる製品であり，「あなたが」いかに用いるかを活用形にして“隠れた”導入語にすれば，製品解説 およびマニュアルの主文および補足文を発想できます．あわせて，読者の視点に沿った文体に統一できます．

発想のポイント1：製品は何であるか

例：　製品もしくは製品の一部は，（あなたが知っている用語で表すと）＊＊＊＊です．／製品もしくは製品の一部は．AとBで構成されています．

発想のポイント2：製品を使う有効性・必要性は何か

例：　（あなたが）製品もしくは製品の一部を使うと，（あなたは）[（あなたの）目的]を[達成]できます ．／（あなたが）[（あなたの）目的]を[達成]するには，（あなたには）製品もしくは製品の一部を[操作]する必要があります．

発想のポイント3：製品はどのように機能するか

例：　（あなたが）製品もしくは製品の一部を[操作]すると，（あなた操作により）[結果]が[表示]されます ．／製品の一部が[ある状態]になります／[製品]が[動作]します．

発想のポイント4：製品をいかに使うか

例：　（あなたは）製品もしくは製品の一部を[操作]します．／製品もしくは製品の一部[に対し誤った取扱い]をしないでください ．

「執筆者（メーカ）の視点」から「読者（ユーザ）の視点」へ

製品解説あるいはマニュアルは，「（ユーザの前にある）製品」と「（ユーザ＝読者である）あなた」の関係を表す技術文書とも言えます．限られた箇所を除き「（開発者である）私 ／私たち」 が前面に登場する必要はありません．先のセクションで述べた「補足的な視点」です．あたかも報告書のように執筆者の視点で読者に述べるのではなく，傍らでユーザと同じ目線で説明する文体を想像してください．

• ここで言う限られた箇所とは，たとえば，「ユーザに対し勧告する（例：当社は・・・を推奨します）」あるいは「定義する（例：＊＊を＊＊＊とします）」などです．

• しばしば，見出し名に続けて「（私は）［見出し名］について解説します」あるいは図・表説明があるにもかかわらず図・表の前で「（私は）［図・表名］を示します」としている例を見かけます．要点を述べていないとともに見出し名あるいは図・表説明と重複していてあまり意味がありません．むしろ，読者にとっての要点を述べるべきです．

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

		実務別技術文書セミナー（出張開催形式）「わかりやすい技術文書の作成手法」は，業務で作成する機会の多い文書に応じた「コース選択式」です．各コースごとに必要な考え方・手法・ポイントを事例中心で解説します．
		.
		.
		.

		マニュアル作成セミナー（出張開催形式）「わかりやすいマニュアルの作成手法」では，「これからマニュアルを作成する」あるいは「見直しをしたい」方々のために基礎と実務知識を実用例・参考例で解説します．
		.
		.
		.

テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー
わかりやすい技術文書・ビジネス文書の作成手法
技術文書の「書き方」−共通のポイントと各種文書への応用−
Copyright:Takaaki-YAMANOUCHI/1995-2010
山之内孝明／(有)山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.