18-4 システム操作マニュアル:「操作手順」と「注意喚起」の表し方
操作手順の1項目は、「操作の指示」と「操作の結果」で構成される段落です。ここでの段落とは、要点である「主文」とそれを補完・展開する「補足文」で構成されるまとまりです。
➢ ログイン画面が表示されます。 ・・・ 操作の結果(補足文)
「してはならない事項」あるいは「しなければならない事項」を述べる注意喚起も、「注意の指示」と「注意の理由」で構成される段落です。
✦ フォルダ名を変更すると、保存したファイルが開けなくなります。 ・・・ 注意の理由(補足文)
いずれの主文も、ユーザーである読者を「省略された主語」にした他動詞文が基本です。
(あなたは)[業務]アイコンをダブルクリックしてください。 ・・・ 操作の指示(主文) 他動詞文
(あなたは)保存先フォルダの名前を変更しないでください。 ・・・ 注意の指示(主文) 同上
操作手順の1項目は箇条書きではありません。箇条書きととらえると、表し方に無理が生じます。
今回は、グラフィカルユーザーインターフェースを基調にしたシステム操作マニュアルでの操作手順および注意喚起を表す際の原則を解説します。操作手順の書式などは、別の回で解説します。
1.
「箇条書き」と「番号付き段落」の違い
2.
「番号付き段落」の構成
3.
手順を表す際の原則
4.
「操作の指示」を表す際の原則
5.
陥りやすい事例:原則から逸脱した表し方
6.
「操作の結果」の表し方
7.
陥りやすい事例:ユーザーの視点で表されていない「操作の結果」
8.
「操作の付帯事項」の表し方
9.
「注意喚起」の表し方
10. 注意を指示する文の表し方
11. 陥りやすい事例:曖昧な注意喚起
まとめ
後 記
© Yamanouchi Takaaki 2024
[注]今回のテーマは他の回と関連するため、以前に解説した内容と重複する箇所があります。
ブログの本文は、下記のPDFファイルで閲覧できます。
本文のPDFファイル(A4判・全31ページ)
【重要】 PDFファイルの表示に伴うトラブルへの責任は、一切負いません。
ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文をPDFファイルにして概要・目次に添付しました。HTML形式ではワープロ文書の表し方を解説しきれないというのがその理由です。
l PDFファイルは、5MB以内です。使用する閲覧ソフトウェアによって表示の細部が若干異なる場合があります。
l PDFファイルの利用は、閲覧のみです。共有やダウンロードなどのご要望には応じかねます。
コメント
コメントを投稿