|
製品・システムのマニュアルを作成する際に機能仕様書をベースにする場合がしばしばあります。ただし、同じ製品・システムが対象でも、マニュアルと機能仕様書は目的が異なる文書です。機能仕様書をベースにする際は、その違いを把握しマニュアルに変換する必要があります。 |
見出し構成を比較すると、機能仕様書は定型性が高くかつ階層的な構成に対し、マニュアルは定型性よりも読者の“見通し性”を優先し不要に階層化しない構成が基本です。機能仕様書の見出し構成を基準にしてマニュアルの見出しを構成すると、利便性を欠いたマニュアルになるおそれがあります。
同様に機能仕様書では略語あるいは複合語を主体にした定型的な見出し名（機能名など）を用いるのが通例です。これをマニュアルに流用すると、読者には何を対象にしてどのような解説あるいは操作をするのか明確に伝わらないおそれがあります。
機能仕様書をマニュアルのベースにする際は、機能仕様書の階層構成を調整するとともに見出し名も見直すのが適切です。
機能仕様書は、執筆者による仕様の指定「（私たちは）-を-とする」とともに製品の動作「製品は−を-する」が主体の文書です。対してマニュアルは「（あなたが）-操作すると、（操作により）-が−されます／-します」と 読者の視点で表します。
機能仕様書の「主たる視点」が「（ともに開発する）私たち」に対し、エンドユーザ向けの製品解説あるいはマニュアルでは「（ユーザである）あなた」です。
機能仕様書をマニュアルのベースにする際は、文体をそのまま用いず「主たる視点」を変更して用いるのが適切です。
次ページに進む（ボタンをクリックしてください）
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2019
山之内孝明／有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.