著書

"取扱説明書の本質を知る"、"取扱説明書の設計"、"取扱説明書の制作" の3部構成で取扱説明書の設計の方法から制作の実務までをわかりやすく解説しています。(日刊工業新聞社から出版)

Book

"Get to know the essence of an instructions manual", "The design of an instructions manual", and "Preparing of an instructions manual", these composition explains clearly the view and the preparing process an instructions manual.

取扱説明書の作成テクニック

まえがき 目次

取扱説明書を作る立場にある人の中には、わかりやすく使いやすい取扱説明書を作りたいと思いながらも、そのために何をどうすればよいか答を見つけられずにいる人が意外に多いのではないでしょうか。その背景には、広く一般的な2つの問題点があると考えられます。
ひとつは、取扱説明書とはそもそも何なのか、定義そのものが明確でないということ。定義が明確でないということは、それがどうあるべきなのかも不明確であるということです。その結果として、製品を使う人の役に立たない取扱説明書が作られることになります。
もうひとつは、取扱説明書を作る方法が確立されていないということ。もちろん、わかっている人もいるでしょうが、その知識が一般化しているとはいえません。わかりやすい取扱説明書を作りたいという理想が頭の中にあっても、それを現実のものにするためには実務に関する知識が必要なのです。

本書では、取扱説明書を「製品の特徴と安全で正しい取り扱い方法を説明した文書」と定義したうえで、取扱説明書を作った実務経験がおおよそ1年以上の人を対象として、取扱説明書の設計と制作の方法を解説しています。

第1部では、取扱説明書を製品の重要部品と位置づけ、現状の問題点を分析しながら、取扱説明書を作る際に知っておかなければならない基礎的な事柄を説明しています。

第2部では、ISO9001による設計管理の手法を用いて、実用フォームを紹介しながら、できばえの良い取扱説明書を作るために不可欠である取扱説明書の設計について説明しています。
ISO9001の要求事項のうちでも理解が難しいといわれる設計管理については、具体例を挙げて解説していますので、取扱説明書の設計のみならずISO9001の設計管理そのものの理解にも役立つはずです。

第3部では、取扱説明書を実際にどうやって制作すればよいか、具体例を示しながら制作プロセスを説明しています。
そして付録では、できばえの良い取扱説明書を作るために何に気をつけなければならないのか、実例を示しながら改善のポイントを説明しています。

取扱説明書を作る立場にある人は、作ることを指示する人も実際に作る人も、本書をよく読んで理解し、できばえの良い取扱説明書を作るために役立ててください。筆者としては、本書が取扱説明書を作るためのバイブルとなることを願っています。

2001年1月 筆者

第1部 取扱説明書の基礎

1.取扱説明書の本質を知る......................2
 ドキュメントとしての位置付け
 取扱説明書の役割
 製品の重要部品
 人によって異なるとらえ方
 取扱説明書のあり方
 取扱説明書への期待
 取扱説明書のプロトコル
 説明する範囲と詳しさ
 手順の説明
 対象による分類
 用途による分類
 読む立場と取扱説明書のタイプ
 タイプによる分類
 操作を覚えるのに適した取扱説明書
 読む立場を考えた取扱説明書

2.取扱説明書による情報伝達を考える........31
 取扱説明書のインストラクション
 インストラクションとは
 インストラクションの与え方
 情報の伝達と理解
 正しい取り扱い情報の伝達
 情報の歪曲
 理解するということの意味
 取り扱い情報の整理
 操作説明
 動作説明
 操作と動作の振り分け

3.取扱説明書の問題点を分析する.............53
 問題点の究明
 取扱説明書の不評の出所
 悪評の分析
 取扱説明書の体裁
 体裁のもつ意味
 体裁を整える要素
 本文の構成
 説明する範囲
 説明する順序
 全体と部分
 取り扱い方法の検索
 目次の重要性
 どこに書いてあるかわからない理由
 取扱説明書の理解とわかりにくさ
 取扱説明書の理解とは
 わからない理由
 わかりにくいとは
 取扱説明書の使いにくさ
 使いにくさとは
 見にくい理由
 レイアウトを考える
 分厚すぎる理由
 製品設計との係わり
 製品が良くない理由
 製品設計へのフィードバック

第2部 取扱説明書の設計

1.一般...........................................114
 取扱説明書の設計
 設計の管理とは
 手順とは
 文書化と標準化
 文書化とは
 標準化とは
 取扱説明書の設計管理

2.設計および開発の計画.......................127
 設計および開発とは何か
 企画とは何か
 取扱説明書の企画
 要望を拾い出す
 要望を整理する
 企画書を作る
 設計の計画を立てる
 何を決めるか
 サンプル原稿の提示
 設計計画書を作る

3.組織上および技術上のインタフェース.....150
 インタフェースとは何か
 組織上のインタフェースとは
 取扱説明書の制作に係わる組織
 連絡の窓口を誰にするか
 何を取り決めるか
 どうやって伝えるか
 技術上のインタフェースとは
 技術上のインタフェースに係わる組織
 何を取り決める 
 どうやって伝えるか

4.設計へのインプット.........................163
 インプットとは何か
 インプットの条件とは
 要求事項をチェックリストで確認する

5.設計からのアウトプット....................178
 アウトプットとは何か
 アウトプットの条件とは
 何を作るか
 どうやって作るか
 アウトプットを確認する

6.設計審査......................................195
 設計審査とは
 いつ行うか
 誰が参加するか
 何を評価するか
 一次審査
 二次審査
 どうやって行うか

7.設計検証.....................................207
 設計検証とは
 いつ行うか
 誰が行うか
 何を確認するか
 どうやって行うか

8.設計の妥当性の確認.........................211
 設計の妥当性の確認とは
 いつ行うか
 誰が行うか
 何を確認するか
 どうやって行うか

9.設計変更......................................219
 設計変更とは
 変更履歴を残す
 変更内容を連絡する

第3部 取扱説明書の制作

1.制作スケジュールの設定....................224
 いつ設定するか
 どうやって設定するか
 スケジュール表を作る

2.取 材.........................................228
 取材とは
 取材前の準備
 担当者を決める
 取材の日時と場所を決める
 段取りを決める
 下調べをする
 持って行く物をそろえる
 取材の実施
 全体の工程を説明する
 製品の説明を聞く
 メモをとるときのポイント
 製品の写真を撮影する
 画面データを取り込む
 取材後の情報整理
 入手資料を確認する
 資料を保管する

3.原稿執筆......................................253
 表紙の書き方
 重要安全情報の書き方
 なんのために書くか
 何を書くか
 まえがきの書き方
 表記上の約束事の書き方
 本文の書き方
 安全に関する書き方
 概要説明の書き方
 取り扱い方法の書き方
 点検整備
 トラブルシューティング
 保管
 廃棄
 後付けの書き方
 アフターサービス
 奥付
 保証書の書き方
 保証書とは何か
 どのように書くか

4.図表の作成...................................340
 イラスト作成の依頼
 挿入するイラストを決める
 作成するイラストを指示する
 イラストのイメージを伝える
 写真のデータを渡す
 イラストの仕様を伝える
 イラストの価格を決める
 写真の使用
 表の作成

5.レイアウト..................................351
 レイアウトとは
 レイアウトのポイント
 情報のビジュアル化とは
 テンプレートとは
 テンプレートを作る
 ページ設定をする
 文字の書体と大きさを決める
 インデントを決める
 行送りを決める
 構成要素ごとのデザインを決める
 オブジェクトの引力を考慮する 
 改丁の基準を決める      

6.取扱説明書の検証............................376
 検証とは何か
 一次原稿チェック
 二次原稿チェック
 設計の見直し

7.印 刷 .......................................383
 印刷の準備
 丁合を整える
 用紙を選ぶ
 印刷の実行
 用紙をセットする
 テスト印刷をする
 仕上げ印刷をする
 製本

付録 取扱説明書の改善のポイント

1.全体の構成...................................390
 重要安全情報を記載する
 読む人に必要な情報だけを記載する
 目的に沿った順序で説明する
 取扱説明書の役割をまえがきで説明する
 製品の名称や型式を表紙に記載する

2.操作説明......................................395
 操作の目的を表す見出しを付ける
 手順の序数を7±2以内にする
 手順は箇条書きにする
 事前の説明は取り扱いの前に記載する
 操作と動作を区別する
 参照指示を適切に行う

3.文 章........................................401
 短い文で書く
 一文一意にする
 肯定文で書く

4.用字・用語...................................404
 わかる言葉で書く
 過度の修飾語を使わない
 用語を統一する
 一語一意で書く
 差別用語を使わない

5.レイアウト...................................409
 目線の流れを考える
 ホワイトスペースを有効に使う
 文字と絵をバランス良く配置する
 図の大きさをそろえる
 正しい絵を入れる

サンプルフォーム一覧

 制作企画書(設計仕様/制作仕様 兼用)
 設計計画書
 取扱説明書チェックリスト
 取扱説明書の設計書
 目次構成表(ソフトウェア)
 目次構成表(ハードウェア)
 一次審査用のインプット確認表
 懸案事項フォローアップ票
 二次審査用の確認表