操作の対象によっては、「手順の数が多い」あるいは「他の操作と重複する手順がある」などさまざまなケースがあります。適切に表さないと、手順を誤解される場合もあります。これらに応じた応用的な手法も知っておく必要があります。 |
先のセクションで述べたように、手順の1項目は、「指示文を主文にした1段落(必要に応じ補足文、図・表、注記)」です。GUI操作であってもCUI操作であってもこの基本は同じです。
しばしば、指示文(主文)と結果(補足文)のそれぞれに手順番号を付けている例を見かけます。分けしまうとそれぞれが主文となり、不統一をきたします。
CUI操作の指示文は、「〈手段〉で〈目的〉を〈達成〉する(例:**コマンドで-を-します)」が基本です。
プログラム開発で用いられる表現が元になった文体と言えます。
対して、GUI操作では、操作を基準にして「〈対象〉を〈操作〉します。〈結果〉が表されます/表れます(例:**をクリックします。**が表示されます」とするのが基本です。それぞれに応用形がありますが、基本の文体からの派生形です。
GUI操作のシステムのマニュアルで「CUI操作風の文体を用いている」あるいは「双方を混合している」事例を見かける場合があります。不要に慣例からはずれないとともに文体の統一が必要です。
一つのマニュアルにCUI操作とGUI操作が出てくる場合もそれぞれの慣例に沿って表すのが適当です。
実践テクニカルライティングセミナー
マニュアル作成の進め方とわかりやすいマニュアルのポイント
Copyright: Takaaki-YAMANOUCHI/1995-2020
山之内孝明/有限会社 山之内総合研究所
Takaaki Yamanouchi/ Yamanouchi Research Institute, Ltd.