短期間で上達できるテクニカルライティング

コツを知れば短期間で上達します

その7:マニュアルの良し悪しは企画構成が決め手|

企画構成案は、ディレクターなど別の方が作成することもあります。
テクニカルライターは書くだけ、そんな場合もあります。
しかし、テクニカルライターの方は、知っておいてください。
企画構成は、マニュアルの設計図です。
基本を正しく理解していないと、良いライティングができません。

企画構成を誤ると、良いマニュアルはできません。
ユーザーの分析が、一番重要であることを理解してください。
多数の書籍が出版されていますので、参考にしてください。

この記事では、基本だけを書きます。

ステップ1.製品の情報を収集

・開発コンセプト ・製品の位置づけ ・機能、性能、仕様
・使用目的と予見できる誤使用    ・安全性
・操作性              ・ターゲットユーザー

ステップ2.製品を分析

・製品背景の分析  ・製品特徴の分析  ・導入作業の分析
・製品機能の分析  ・操作性・作業性の分析
・活用性の分析(オプションや他製品との組み合わせでの使用など)

ステップ3. ユーザー(使用者)の分析

誰が、何を目的として、どういう風に使うのかを分析します。
・製品を使用するために必要な知識、経験、環境、資格
・使用目的 
・使用時の危険性と予見できる誤使用
ユーザーに安全に使ってもらうために、一番重要なポイントです。

f:id:openup21:20210821113226j:plain

ステップ4. 記載しなければならない情報を洗い出す

・設置、操作、保守、トラブルシューティングの詳細項目

インスラクション項目とリファレンス項目に分けて検討します。
[インストラクション項目]
 通常レベルのユーザーが読む項目です。
[リファレンス項目]
 すでにある程度の知識を持っているユーザーが読む項目です。

ステップ5. 目次構成(ストーリー)を決める

章、節、項の目次を決めます。
「分冊にするのか、しないのか」
「インストラクションかリファレンスか」
「対象が操作担当者か保守担当者か」なども決めます。

f:id:openup21:20220219152923j:plain

ステップ6. 表現設計を決める

・情報を区分
 注意事項(危険、警告、注意)、手順、結果、説明、補足、参照など
 情報の区分を明確にします。
・表記ルール
 情報の区分ごとに文体(ですます調など)、記号、書体などを決めます。
・図版(イラストや図)ルール
 イラストの大きさ、配置、ファイル形式などのルールを決めます。
・レイアウト
 情報の区分をもとに、レイアウトをデザインします。
 (シンプルなデザインが望ましい)

f:id:openup21:20210811091959j:plain

ステップ3.のユーザーの分析を誤ると、ステップ4.以降は正しい内容になりません。
特に、予見できる誤使用を見落とさないでください。

実際の目次例:消費生活用製品(民生品)

f:id:openup21:20220318200839j:plain

・表紙
・重要事項説明
・商品説明
・各部の名称
・安全上のご注意(危険、警告、注意)
・使用方法(組立方法、取付方法)
・お手入れの仕方
・故障かなと思ったら
・修理の窓口
・保障規定
・製品仕様
・責任主体表示

実際の目次例:工業用製品(産業機械の例)

f:id:openup21:20220318211112j:plain

・表紙
・はじめに
・機械の使用目的
・作業資格について
・機械の廃棄に関して
・仕様銘板位置について
・安全作業を行うために

1. 安全に関する注意事項
  1-1 全般的な安全注意事項
  1-2 作業別の安全注意事項
  ・
  ・
  1-3 危険区域
  1-4 安全機器
  1-5 警告ラベル
  1-6 残留リスクマップとリスク一覧
2. 仕様
3. 据付
  3-1 据付時の安全注意事項
  ・
  ・
4. 操作
  4.1 操作時の安全注意事項
  ・
  ・
5. 保守
  5-1 保守時の安全注意事項
  ・
  ・
冒頭だけでなく、各項目にも安全注意事項を記載してください。

ライターには必須です!