Effective manual creation

効果的なマニュアル活用法

-すべてのナレッジを価値に変える-

取説の作り方とは?基礎知識から具体的な記載内容・注意すべきポイントについて詳しく解説!

取説の作り方とは?基礎知識から具体的な記載内容・注意すべきポイントについて詳しく解説!

2023/09/15

製品を購入すると同梱されている取扱説明書。近年は印刷されたものだけでなく、電子データ化されたものも多く、Webサイトからダウンロードできたり、グローバル展開の製品については多言語に翻訳されたりなど、製品のユーザーに広く行き届くようさまざまな工夫がなされています。

この記事では、取扱説明書の基本的な作り方や記載内容、注意すべきポイントなどについて詳しく解説します。取扱説明書の作り方や、作る際に知っておくべき知識があれば知りたいとお考えの方に、参考にしていただければ幸いです。

取説の作り方を学ぶ上で知っておきたい基礎知識

取扱説明書(以下、取説)の作り方を学ぶ上で、知っておきたい基本的な知識をご紹介します。

  • 取説とは?
  • 取説の必要性
  • 取説と業務マニュアルの違い

取説とは?

取説とは、製造した製品について、その正しい使い方や安全上の注意、メンテナンス方法やエラーの対処方法などをユーザーに向けて説明する文書です。

その製品の各機能を使うことでどんな効果が得られるのか、どんな使い方をすると危険があるのかをユーザーに伝えます。そのため、イラストや写真を添えて、初めてその製品を扱うユーザーが内容を理解しやすいような表現が用いられます。

本やパンフレットのような印刷物で製品と同梱されたり、電子化されたPDFファイルの形式でCD-ROMから読み取ったりメーカーのWebサイトからダウンロードしたりする方法で配布され、ユーザーの元に届きます。

取説の必要性

取説の作り方を学ぶ上で知っておきたい基礎知識

取説がなぜ必要かというと、製品の正しい取り扱い方をユーザーに伝えるためです。

もし取説がなかったら、ユーザーは危険な使い方をしてしまうかもしれません。その結果、怪我をしたり使用場所で火災が発生するなど甚大な被害をこうむったりする可能性があります。また「いつもと音が違う」「動きが遅くなった」など製品が普段と異なる状態になったとき故障かどうかがわからず、使い続けていいのかユーザーは迷ってしまいます。問い合わせ先もわからないと、企業の代表電話に連絡が殺到し、迅速な対応が受けられないかもしれません。

このような事態からユーザーを守るため、また販売者が製品についての問い合わせやメンテナンスをきちんとしたフローで請け負うためにも、取説は製品にとって必要な存在なのです。

取説と業務マニュアルの違い

取説と業務マニュアルの違いについて、確認しておきましょう。

業務マニュアルは、業務の全体像や手順、注意点、事例などを記載した文書です。取説と同じようにイラストや写真を用いて手順などをわかりやすく説明したものですが、内容は異なります。取説が製品についてユーザーに知ってほしい部分のみを説明するものであるのに対し、業務マニュアルは業務に関わる知識について幅広く専門的なレベルまで網羅的に説明します。

また、想定する読み手にも違いがあります。取説の読み手は製品を購入した不特定多数のユーザーであり、その製品についての情報源はほぼ取説のみです。一方、業務マニュアルは企業や組織でその業務に携わる従業員を読み手として想定しており、限られた人数です。従業員は業務遂行にあたって業務マニュアルだけでなく職場の人からの指導も受けますから、業務についての情報源はマニュアル以外にもあります。

そのため、取説は読み手が困らないようトラブルシューティングやFAQをできるだけ詳しく記載しますが、業務マニュアルには取説ほど詳細なFAQは記載しない、という違いもあります。

取説の作り方

取説の作り方について見ていきましょう。次の6つの手順でご説明します。

  • 全体構成と読み手を決める
  • イラストや写真を使用する
  • 操作方法は結果もわかりやすく記載する
  • トラブルシューティングはできるだけ詳しくする
  • 索引を作り検索しやすいようにする
  • PL法に基づき注意事項を記載する

【手順1】全体構成と読み手を決める

取説の作り方

作成前に、全体の構成を考え読み手を想定します。

取説は、一般的に次のような構成となっています。これに、製品の性質によって必要な項目を足したり、不要な項目を差し引いたりするとよいでしょう。

  • 表紙
  • 目次
  • 注意事項(安全上必要なこと、してはいけないこと)
  • 基本的な使い方(準備、部品名、使い方など)
  • 応用的な使い方(オプション機能や便利な活用法など)
  • メンテナンス方法
  • 廃棄方法
  • トラブルシューティングやFAQ(よくある質問、エラーコード一覧など)
  • 索引
  • 保証やアフターサービス
  • 製品の仕様(寸法やサイズ、重量など)
  • 裏表紙

読み手を決めるときは、まず製品のユーザーは一般消費者か、仕事で使用するプロかを考えます。次に、誰がどんなシーンで使うのかを考えます。

例えば製品がおもちゃであれば、保護者が子どもと家庭で使うシーンを想定し、初めておもちゃを目にする親が理解できるよう易しい言葉で説明します。製品が工場で取り扱う機器で、ユーザーが工場勤務の従業員であれば、その業界の人がわかる用語を使って説明します。

【手順2】イラストや写真を使用する

取説の作り方

取説作成の段階では、イラストや写真を使い、ユーザーが直感的に内容を理解できるようにします。

写真は、その製品の実際の状況を説明なしに伝えられますから、「スイッチ」「水を入れる投入口」など、外見から見てとれる情報を伝達しやすいでしょう。ただ、モノトーン印刷の取説では色は伝えにくいので注意が必要です。

イラストは、写真に写らない内部や裏側の情報を伝えることができ、そのためのさまざまな手法があります。物体をある一点から見たように立体的に描く投影図法や断面図、部品と製品本体を平行に並べ点線でつなげることで取り付け箇所を表す分解図など。特に注目してほしい部分には網掛けをしたり太線にしたりして工夫しましょう。

これらの手法を用いて線画を作成する技術はテクニカルイラストレーションと呼ばれています。国家検定に合格した技能士の資格を持つイラストレーターに依頼するとよいでしょう。

専門的なイラストのほか、「やってはいけない例」「危険な例」をわかりやすいイラストやアイコンで表現するなど、ユーザーに伝わりやすい表現を心がけましょう。

【手順3】操作方法は結果もわかりやすく記載する

製品の使い方の説明では、操作方法とともに操作結果がどうなるのかもわかりやすく記載します。

例えば、デスクスタンドのスイッチを押す操作であれば「スイッチをタッチするとライトが点灯します」のように記載します。このように「(操作)をすると(結果)になる」という表現で記載するとわかりやすくなります。

初期不良があって点灯しない場合があると、どの状態が正常かわからずユーザーは不安になります。操作方法を伝えるという意味では「スイッチをタッチする」までですが、「点灯します」のような端的な表現で結果も記載しましょう。

【手順4】トラブルシューティングはできるだけ詳しくする

取説の作り方

トラブルシューティングのページはできるだけ詳しく記載します。

トラブルシューティングとは英語の動詞troubleshootからきた言葉で、「解決する」「修理する」といった意味があります。取説においては、エラーや異常と思われる状態や考えられる原因、解決策を発生の可能性が高いものや問い合わせが多いものについて記載するものです。

製品の画面に表示されるエラーコードがあるならその番号を記載します。エラーコードがなければ、例えば「音」「におい」など状態別に整理して「ガーガーという音がする」「ピーというアラーム音が3回鳴っている」のように、ユーザーがわかりやすい表現で記載します。考えられる原因には「プラグがゆるんでいる」「使用場所の室温が低い」などと記載し、トラブルそのものや原因のカテゴリ別に解決策を提示します。

ユーザーの使い方や使う環境はさまざまですから、あらゆるトラブルをカバーするのは難しいですが、可能な限り想定して記載します。併せてアフターサービスの案内も入れておきましょう。

【手順5】索引を作り検索しやすいようにする

取説には索引や用語集のページを作り、言葉から検索できるようにします。電子ファイルの取説であれば端末上でキーワード検索ができますが、紙の取説では索引があるとユーザーが必要な情報を探しやすくなります。

例えば、電子レンジで「庫内洗浄」というマークが点滅表示されていると、ユーザーは「使い方」ページか「お手入れ」ページなのかと迷います。そのとき索引があれば「庫内洗浄…P.24」というようにページ番号がわかり、すぐ該当のページを見つけることができます。

数ページの取説であれば索引がなくても探せますが、50ページ程度のボリュームになると探すのに時間がかかります。索引や、言葉の意味を解説した用語集を用意すると親切です。

【手順6】PL法に基づき注意事項を記載する

取説の作り方

PL法とは製造物責任法(Product Liability Act)のことであり、平成6年7月1日に公布された消費者庁所管の法律です。製品を販売する事業者はPL法を念頭に置いて取説を作成する必要があります。

PL法は、製品の欠陥が原因でユーザーに損害が生じた場合の損害賠償について定めた法律であり、製品の販売者の義務や届け出を求めるものではありませんが、損害賠償を求められるような事態を防ぐために、取説でわかりやすく説明することが対策となります。

この法律には表示の規定はありませんが、業界によってはガイドラインを設け、独自の記号やマークを定めています。例えば一般財団法人家電製品協会では以下のように定めており、家電製品では3つのレベルのうち該当するものを取説で表示する必要があります。

“家電製品を安全に使うために、製品本体や取説には警告図記号または注意を促す図記号がついています。危害・損害の程度に応じて、「危険」「警告」「注意」の3つのレベルがあります。”

出典:一般財団法人家電製品協会

製品の使い方によって危険が生じるおそれがあるならば、その使い方や危険な結果をユーザーが回避できるよう、わかりやすいように表示しましょう。

取説の作り方で注意すべきポイント

取説の作り方で注意すべきポイント

取説を作る上で、注意するとよいポイントを3つご紹介します。

  • PL法の遵守
  • 随時更新が必要
  • シンプルに記載する

PL法の遵守

前の章でも述べたように、PL法を遵守し、ユーザーが危険を回避して安全に製品を扱えるような取説を作成しましょう。

PL法では製品のことを「製造又は加工された動産」と定義しており、製品の販売者がどのような処理を加えて作ったかはユーザーにはわかりませんから、正しい扱いを伝える責任があります。以下のようなポイントを検討してみましょう。

  • 業界で定めたガイドラインはあるか
  • 自社の製品について、訴訟につながるポイントはあるか
  • 文字を目立たせる、イラストを付けるなどの手法で十分注意喚起しているか

訴訟につながるポイントを検討する際は、消費者庁がPL法に基づく過去の訴訟事例をまとめていますので、そちらを参考にしてみてください。

随時更新が必要

取説に継続して正しい情報を掲載するため、随時内容を更新しましょう。

例えばユーザーからの問い合わせやクレームを受けて仕様に変更があったり、原材料の変更に伴いメンテナンス方法が変わったりと、販売開始後に製品のマイナーチェンジが発生することがあります。変更のあった製品には、変更が反映された取説を同梱させる必要がありますから、取説は随時更新していきます。

このように製品の販売タイミングによって取説が異なるバージョンになっていきますから、バージョン管理も徹底することが重要です。

シンプルに記載する

取説の作り方で注意すべきポイント

文章表現はシンプルに記載しましょう。

取説の読み手は、大人か子どもか、個人などの消費者か企業などの生産者か、といった属性は想定できますが、それぞれのユーザーの経験値はさまざまです。読み手は初めてその製品を使う人であると想定し、何をしてほしいかシンプルに記載しましょう。

例えばこのようなポイントで記載するとわかりやすくなります。

  • 一文を短くして、一文の意図するものは一つにする。
  • 専門用語はできるだけ避けるか必ず解説をつける。
  • 動作や部品の名称など、取説内での表現は統一する。
  • 「ない」が2つ続く二重否定は使わず、「していいこと」を表現する。
    (例)「安定していない場所では使わないでください」→「安定した場所で使ってください」

取説作成後は複数の人に読んでもらい、伝わりやすさを確認するとよいでしょう。

お役立ち資料:『業務マニュアルをクラウド化するメリットとは?~業務マニュアルクラウドツールをお悩みの方は必見!~

まとめ

今回は、取説の作り方について、知っておきたい基礎知識や作り方、作る際のポイントについて解説しました。

取説はユーザーに製品を安全かつ便利に使ってもらうために、情報をわかりやすく伝えるものです。製品を初めて扱う人をイメージして、わかりやすい表現でPL法に配慮して作りましょう。製品の仕様に変更があれば更新し、どの製品のバージョンに対応した取説か、バージョン管理も重要です。

取説を「マニュアル作成ツール」で作成すると、編集や管理の面でメリットがあります。特にKnowledgeSh@re(ナレッジシェア)は次のような特徴が取説作成をサポートしてくれます。

  • Microsoft wordに近い操作感で、文書編集の経験が少ない担当者も簡単にドキュメント編集できる。
  • 複数の文書内の同じ箇所に、一度に修正を反映できる。
  • 製品リリースの直前まで、リアルタイムで編集が可能。
  • バージョン管理が1つのツール内で完遂する。
  • 多言語翻訳に対応できる。
  • セキュリティのしっかりしたクラウドで情報管理を行う。

こちらの記事では、取説をツールで作成した事例をご紹介していますのでぜひご覧ください。

関連記事:「直感的なツール」の導入で取説の内製力強化を実現!~トリセツ作成リードタイムの大幅短縮で、最新情報の提供が可能に!~【導入事例】i-PRO株式会社様

KnowledgeSh@re体験版 60日間無料

KnowledgeSh@re体験版 60日間無料

富士通ラーニングメディアの「KnowledgeSh@re」

取扱説明書の作成・運用にもKnowledgeSh@re(ナレッジシェア)が役立ちます。
本格的なマニュアルが手軽に作成でき、品質のばらつきも削減できます。どのようなツールなのか、60日間の無料体験で確認できます。

マニュアル作成・共有ツール『KnowledgeSh@re無料トライアル
※資料はこちら

記事一覧ページへ戻る

お問い合わせはこちらから