17-2  取扱いマニュアル:「取扱い手順を述べる項目」の表し方

 取扱いマニュアルの大部分は、「取扱い手順を述べる項目」です。項目とは、見出しとそれ以降の内容です。

取扱い手順を述べる項目   ユーザーが「一つの目的」を達成するのに必要な「知識と手順」をまとめた項目

取扱い手順の一つ一つは、それぞれ「番号付き段落」として表します。取扱い手順を述べる項目は、見出しの後に必要な知識を述べる「導入段落」があってこれにいくつかの番号付き段落が連なる構成になります。

番号付き段落   手順番号を伴って「操作の指示」と「指示の付帯事項」で構成される段落

手順は、箇条書きではありません。手順を箇条書きととらえると、指示の付帯事項が表しづらくなります。

今回は、操作の趣旨および手順の前提となる事項を述べる「導入段落」の表し方を中心にして解説します。手順の表し方は別の回で解説します。

1.     「見出し-導入段落-手順」の構成

2.     導入段落の表し方

3.     陥りやすい事例:製品の動作と仕様が主体になった導入段落

4.     「箇条書き」と「手順」の違い

5.     「手順」を表す書式の基本

6.     陥りやすい事例:原則から逸脱した書式

7.     「手順全体の注意喚起」と「手順各項の注意喚起」の区別

8.     「節見出し-導入段落-手順」の構成では表せない操作

9.     陥りやすい事例:原則から逸脱した「節-項」構成

まとめ

後 記

© Yamanouchi Takaaki 2024

[注]今回のテーマは他の回と関連するため、以前に解説した内容と重複する箇所があります。

ブログの本文は、下記のPDFファイルで閲覧できます。

本文のPDFファイルA4判・全28ページ)

【重要】 PDFファイルの表示に伴うトラブルへの責任は、一切負いません。

 ブログではタイトルを開いたページに本文を表すのが普通ですが、あえてワープロで作成した本文をPDFファイルにして概要・目次に添付しました。HTML形式ではワープロ文書の表し方を解説しきれないというのがその理由です。

l PDFファイルは、5MB以内です。使用する閲覧ソフトウェアによって表示の細部が若干異なる場合があります。

l  PDFファイルの利用は、閲覧のみです。共有やダウンロードなどのご要望には応じかねます。




コメント

このブログの人気の投稿

1-1  「見出し構成」とは

1-2  見出し構成の「原則」

テクニカルライティングの効果:文書品質の向上と作成時間の短縮