文書構成の考え方
見出し構成の考え方


製品解説マニュアルの見出し構成

 

同じ製品を対象にしていても,機能仕様書は「開発者間での仕様の共有」が目的の定型を基本とした文書であるに対し,製品解説あるいはマニュアルは「ユーザにとっての製品の理解」を目的とした文書です.見出し構成を考える際の開発側の論理で構成するのではなく,ユーザの 視点で構成する必要があります.


“見通し”がよい見出し構成

製品解説あるいはマニュアルは,上位の見出しランクで“ユーザが知りたい”事項が見つかる“見通し”がよい見出し構成である必要があります.不要に階層化すると,読者が必要とする事項を見つけにくいばかりか,読者が知らなければならない重要な事項が見落とされるおそれがあります.


製品解説・マニュアルの章構成

製品解説では,「ユーザが求める情報」から見出しを構成するのが適当です.製品解説の総論部は「知識獲得」と「目的達成」をキーワードにして直列的 な(ユーザが必ずその順序を追って読む)章構成とし,各論部は 「問題解決」をキーワードにユーザが選択的に読める並列的な章構成にするのが適当です.


見出し構成の調整

見出し構成は,文書作成の第1段階で検討するとともに,執筆がある程度進んだ段階で見直す必要があります.

製品を理解してもらうのに不要な負担をかけては,製品解説を読んでもらえません.とりわけ,「数的・量的な負担」を避け,読者の集中が続くページ数あるいは項目数で構成するのが適当です.「ページ数が多い項目の分割」あるいは「過渡に多い節を含む章の分割」などの調整が必要になる場合があります.

既存の文書の見出し構成を参考にする場合も,当該の文書に応じた調整が必要です.とりわけ,上位の見出し(例:章見出し)をそのまま適用すると,当該の文書では章によってページ数が極端に偏る場合があります.


変則的な見出し構成のチェック

読者であるユーザは,文書が「さまざまな文書に共通のルール(誰もが標準と認める規範)に基づいて構成されていると理解して文書を読みます.それに反して,矛盾を含んだ変則的な見出し構成を用いると読者の誤解につながるおそれがあります.

また,一つの文書で見出し構成の基準が“あいまい”では読者に混乱を生じます.同じ見出しが一度目と二度目で使われ方が違うと,不自然なばかりか誤解につながるおそれもあります.


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

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

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



テクニカルドキュメント・ビジネスドキュメントためのテクニカルライティングセミナー
わかりやすい技術文書・ビジネス文書の作成手法
Copyright:Takaaki-YAMANOUCHI/2002-2010
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute,Ltd.
 takaaki@yamanouchi-yri.com