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


指示文の基本

   

読者である「行為者(例:ユーザ)」を主語にして「しなければならない行為」を表す文を「指示文」とよびます。多くの場合は「(あなたは)対象を行為してください」と文末を敬語で表しますが、マニュアルによっては「-する(平常文)」あるいは「-します(平常文の丁寧表現)」で表す場合があります。


1項目1行為」の原則

いくつかの指示文で手順(箇条書き形式)を構成する際、その1項目に表す指示文は一つ(1行為)とするのが原則です。操作マニュアルなどで不要に複数の指示文を1項目にまとめると、誤操作につながるおそれがあります。

とりわけ、途中で結果の確認を要する手順では、不要に複数の行為(操作)を1項目にまとめないのが基本です。


結果を伴う操作の表し方

指示文とともに結果(例:製品の動作)も「読者の視点」で表します。指示文が「(あなたは)-を-します」に対して、結果も「(あなたから見ると)-が-されます〈受け身文〉」もしくは「(あなたから見ると)−が-します〈自動詞文〉」で表すのが基本です。

ただし、一部のマニュアルでは結果を「(あなたから見ると)製品が-を動作します〈他動詞文〉」で表す場合があります。とりわけ、プログラム開発ガイドなどではプログラムコンポーネントの“動作”を「**クラスが**を取得します」と必ず主語を明示した他動詞文で表します。


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


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