マニュアルは、ユーザである読者が中心の文書です。マニュアルでは、製品(およびシステム)あるいは業務を的確に解説するとともに操作あるいは行動を動機付ける必要があります。さらには、明確に行動の手順あるいは注意を示さなければなりません。
マニュアルの執筆でもっとも最重要なのは「読者」を中心にして表すことです。「読者=行為者(多くの場合はユーザ)」と位置付け、読者を「主たる視点」に置いて表す必要があります。平たく述べれば、マニュアルは、“読者が主人公”の文書です。
「主たる視点」とは、文書中で「中心になって行為する人 (行為の主体)」です。報告書ならば、「(報告する)私」であり、マニュアルならば「(操作する)あなた」です。いわゆる、文を書く際の「人称」に相当し、日本語ではなじんだ習慣です。
「主たる視点」の考え方は、技術文書の「書き方」−共通のポイントと各種文書への応用−で解説しています。あわせてご参照ください。
同じ製品でも、機能仕様書は仕様の指定「(私たちは)-を-とする」とともに製品の動作「製品は−を-する」が主体 となったメーカ(=執筆者と読者が一体)が主たる視点の文書です。対してマニュアルは「(あなたが)-操作すると、(あなたの操作により)-が−されます/-します」と読者を主たる視点に置きます。
当社では、少人数から開催可能なテクニカルライティング研修コース(出張開催セミナー)を ご用意しています。出張開催セミナーは、当コーナーの最後でもご案内しています。
当コーナーでは、各種マニュアルの共通基礎からその一部を解説します。また、プレビュー版の主旨から解説の一部を省略する場合があります。
<当コーナーの主旨とご閲覧にあたってのお願い>
当コーナーは、当社のテクニカルライティング研修コース(出張開催セミナー)の抜粋・プレビュー版です。
|
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright:Takaaki-YAMANOUCHI/2002-2010
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
takaaki@yamanouchi-yri.com