マニュアル制作入門

マニュアル制作の基本、注意すべきポイントをまとめました(2012.10.1改訂)

家電製品をはじめとするマニュアル(取扱説明書・操作説明書)制作には、一定の様式があります。細かい表現ルールなどはメーカーによって異なりますが、マニュアル制作の本質的な部分はそれほど変わりありません。

このコーナーでは、マニュアル制作の基本や注意すべきポイントについて、マニュアル制作のプロセスとともにまとめてみました。ここではいわゆる取扱説明書・操作説明書の制作を対象としていますが、一般的な業務マニュアルに応用できる情報も多いかと思いますので、適宜ご活用ください。また、完成マニュアルを評価するための観点として「マニュアル評価フレームワーク」も公開していますので、あわせてご覧ください。

リンク先の各研究発表ですが、内容的に薄い&少々時代遅れになりつつありますので、適宜リライト進行中です。関連リソースとしてリンクしている、マニュアルライティング講義サポートページ(専修大学ネットワーク情報学部、2012年版)の講義資料もあわせてご覧頂ければ幸いです。

書き始める前に必要な企画構成プロセス

実際に説明のための文章を書き始める前に、以下のような準備が必要です。文章やデザインにリソースを注ぎ込んでも、この企画構成プロセスを疎かにするとマニュアルの品質を上げることは難しくなります。

  1. 説明対象を把握する
    説明に必要な、説明対象の情報を収集します。おおまかには、製品やサービスの概要、既存製品/サービスとの相違点、想定市場と市場におけるポジショニング、できること/できないこと(機能と制限事項)、考えられるトラブル、技術仕様といった情報です。
  2. コンテンツ要件を明確にする
    作成対象のマニュアルの目的とゴール、説明対象ユーザーとコンテクスト(閲覧時の動機・目的や周囲の環境・状況)だけでなく、制作仕様(納期、納品形態、対象言語、ソフトウェアのバージョンなど)も明確にする必要があります。目的については、ビジネスゴールとユーザーゴールを混同せず、それぞれについてしっかり検討することも重要です。
    ターゲットユーザーは誰だ?
  3. 必要な情報を用意する
    提供者がユーザーに伝えたい情報だけでなく、ユーザーにとって必要と思われる情報、法令規定や業界ルールに基づいて記載する情報を収集します。ユーザーの利用状況(製品自体の利用状況とマニュアル閲覧の利用状況)を踏まえて、どのような種類の情報を用意するべきか?を情報の枠組で考える習慣をつけましょう(下図:操作情報の枠組例)。
  4. 構成案を作成する
    用意した情報をグルーピングしてタイトルを付けます。操作が中心のマニュアルであれば、ユーザータスクをベースに情報を構造化することが適切でしょう。また、ユーザーの閲覧時の動機・目的や周囲の環境・状況に基づいて、適切なメディアを選択することも重要です。
    情報を構造化してわかりやすくする
    わかりやすい構成とは?
    わかりやすい見出しのつけかた
  5. 基本的なデザイン設計を検討する
    基本となるデザイン(デザインフォーマット作成・イラスト作成ルールの策定)を設計します。「マニュアルのビジュアル化」が再評価される中で、可読性や視認性に配慮することは当然として、コストとのバランスも考慮しつつ、製品全体のUXへの貢献という視点も必要になってきています。
    マニュアルのデザインについて考える
    マニュアルのデザインについて考える(続)
    ユーザー体験という価値

マニュアルライティングのポイント

企画構成を終えたら、原稿作成作業の始まりです。

「正しく簡潔に、一意に表現する」などの日本語表現法は各種書籍(参考)やネット上の情報(参考)を参照して頂くとして、以下のようなマニュアルならではのポイントに注意しましょう。

  1. 指示説明情報を書く
    取扱説明書・操作説明書でもっとも重要な部分です。
    機能説明と想定利用状況などから構成される導入情報と、指示(ユーザーの行為)と確認(行為に対するフィードバック)のセットで構成される操作情報が主な内容になります。指示が多すぎる場合や条件分岐が複雑な場合は、見出しを分割するなどして情報を整理します。
    まず情報の整理−操作手順の書きかた(1)
    操作文の原則−操作手順の書きかた(2)
  2. 注意情報を書く
    してはいけないこと(禁止)・できないこと(制限)を、指示を守らないことによって生じるデメリットとともに明記します。
    ご注意を読んでもらうには
  3. トラブル時の対応・困った場合の対応を書く
    トラブルが発生した場合の対策を、症状と原因、対策を明確にして記載します。エラーや誤動作などトラブルとして仕様で想定している挙動以外にも、ユーザーが陥りそうな問題について「困ったときは」などの見出しを設けてまとめておきます。
  4. 製造物責任法関係の警告・注意を明記する
    製造物責任法(いわゆるPL法)に基づき、ユーザーの身体や財産に危害が及ぶことのないように、図記号(参考)と共に警告・注意情報を記載します。
  5. 索引を作る
    目次の要素を五十音順・アルファベット順に並べ替えるだけでは、索引の意味がありません。本文中には存在しない場合でもユーザーが想起しそうなキーワードを用意したり、同じ情報を複数の言葉から探すことができるようにするなどの工夫が必要です。
    正しい索引の作りかた

品質向上を目指すための組織環境と品質評価

マニュアル制作を巡る環境は、この10年で大きく変わりました。Webサイトをはじめとする電子媒体だけでなく、取扱/説明情報の製品UIとの統合も含め、まだしばらくは流動的な状況が続きそうです。

このような変化の中で、マニュアル制作を支える人や組織、環境について正しい判断をするためには、様々な面からの情報収集が必要となります。

  1. 制作者への要求スキル
    「脱ライター」が必要とされているのですが、状況はなかなか改善されません。
    取説作成者に求められる素質・能力
    これでいいのか、マニュアルライター
  2. 社内体制
    社内制作体制から外部制作会社への発注という移行が強まっていますが、ハンドリングの巧拙によって完成品の品質には大きな差が出てしまいます。
    メーカー内マニュアル担当者のお仕事
    メーカー内マニュアル担当者のお仕事(2)
  3. 制作システム
    制作データの再利用性を向上させることによる生産性の向上→コストダウンが求められています。ですが、製品ジャンルの枠を超えた再利用は「言うは易く、行うは難し」です。
    マニュアル制作データベース?
    コンテクスト変換という幻想(DITAを巡る話題)
  4. マニュアル評価のポイント
    完成マニュアルに対して適切な評価が行われないと、品質の着実な向上は見込めません。また、不適切な評価によって、改善のつもりが改悪になってしまうことすらあり得ます。
    マニュアル評価のポイント(前編)
    マニュアル評価のポイント(後編)
    マニュアル評価フレームワーク
The 1140px CSS Grid System · Fluid down to mobile