取扱説明書作成におけるガイドラインの役割

序章

取扱説明書を新規に作成する場合、作成の基準となるガイドラインは欠かせません。また、既に作成された取扱説明書の見直しを行う場合にも、見直しのための基準となるガイドラインが必要となります。本記事では、取扱説明書の作成におけるガイドラインの概要について解説します。

ガイドラインの必要性

新製品を初めて市場に投入する場合、過去に他の製品で取扱説明書を作成した経験がなければ取扱説明書も初めて作成することになります。取扱説明書にはどういう情報を掲載すればいいのか、ページのレイアウトや文字のスタイルはどのようにするか、安全に関する表記をどのようにするかなど、さまざまな基準作りが必要となります。

さらに海外市場へも製品を投入するのであれば、輸出先の国の法規へ取扱説明書も適用させる必要が出てきます。こういう場合、海外の各国(地域)の法規に精通した専門家のアドバイスが必要となりますが、自社の製品と同等または類似製品を製造するメーカーの取扱説明書を入手し、その取扱説明書を参考に自社製品の取扱説明書を作成するケースが多く見受けられます。


取扱説明書の作成基準(ガイドライン)を持たずに作成を進めていくことは、根拠が不十分な場当たり的な対応となるだけでなく、その後も取扱説明書を継続的に作成していく観点から考えると、ガイドラインの事前の整備が重要であると考えられます。特に取扱説明書の作成を複数名で行う部門の場合、属人的なルールを排除する上でも、ガイドラインの必要性は高まります。

取扱説明書には、記載内容の正確性、検索性、読みやすさ(見やすさ)、使いやすさ、適切な注意喚起と回避指示、理解しやすい文章レベル(難易度)などの基本的な要求事項があります。

ガイドラインは、これらの要求事項を考慮した上で作成していくことが望まれます。

ガイドラインに記載する情報としては、取扱説明書の記事構成に関する情報、ページレイアウトや書体などのスタイルに関する情報、警告表示に関する情報、執筆(ライティング)ルールに関する情報などに大別されます。

ガイドラインに記載すべき情報1(記事構成に関する情報)

取扱説明書における記事構成は、取扱説明書全体の骨格を成す重要な役割を果たします。また、取扱説明書においては、章・節・項の階層型の構造を持つのが標準的です。記事構成を検討する場合、まずは章立て作業から行っていくのが一般的な手順となります。産業用の機械を例に章立ての事例を見ていきましょう。

< 章立ての事例 

保証と免責事項

重要なお知らせ

用語解説

安全

製品仕様

操作画面

運転手順

清掃と洗浄

保守点検

トラブルシューティング

参考資料

章立てを決定した後、各章の第1階層にあたる「節」の構成を検討していきます。
さらに第2階層にあたる「項」の構成を順次検討していきます。必要に応じて第3階層まで「項」を細分化する場合もあります。このように章・節・項の構成を予め決定し、ガイドラインに記載しておくことで取扱説明書としての統一感を保つことが可能になります。

イドラインに記載すべき情報2(スタイルに関する情報)

取扱説明書においては、ページにおける余白の大きさ、書体(文字の大きさやフォントの種類)、インデントと行間など、全ページにわたってその一貫性が求められます。また読みやすさの観点からJISなどの規格で推奨されている書式や書体を参考にするのも選択肢となります。自社の取扱説明書のガイドラインに以下のようにスタイルガイドとして予め明記しておくことで、原稿作成者や編集作業者の属人的な判断やルールを排除することが可能になります。

< スタイルガイドの事例(一部を掲載)>

(1)文字サイズと字体

章タイトル:14ポイントのゴシック体、節タイトル:12ポイントのゴシック体、
項タイトル:11ポイントのゴシック体、本文:10.5ポイントの明朝体

2)ページサイズと余白

紙面サイズ:A4サイズ、余白:上下25mm、左右20mm

(3)行間:18pt(固定値)

(4)ヘッダー:章のタイトル(奇数ページ:右寄せ、偶数ページ:左寄せ)

(5)フッター:ページ番号(連番表記、センタリング)

ガイドラインに記載すべき情報3(警告表示に関する情報)

取扱説明書はPL(製造物責任)の対策にも重要な役割を持っています。安全設計(リスクアセスメントを含む)に基づいて設計された製品であっても、その製品に残存するリスクを0(ゼロ)にするのは困難なため、ユーザに対して適切な使用上の情報(警告や回避方法など)を取扱説明書や警告ラベルなどによって提供することが求められます。


取扱説明書の警告表示に関しては、JIS規格および国際規格(ISO、IEC、ANSI等)で規定されている表記方法に基づくのが標準とされています。シグナルワード(危険・警告・注意)の使用、目立たせるための工夫(文字サイズを大きくする、ゴシック体を使用する、文字を枠で囲む)などをガイドラインに記載しておくことが重要です。

ガイドラインに記載すべき情報4(執筆ルールに関する情報)

執筆(ライティング)に関するルールは多岐にわたります。

取扱説明書においては一貫性が最も重要であり、またテクニカルライティングの見地に立って文章を適切に記述することも重要なポイントになります。

ガイドラインに、以下の対象項目について順守または推奨ルールを記載しておくことで、執筆者(ライター)の手助けとして活用させることができます。

< 対象項目と順守または推奨ルールの事例(一部を掲載)>
  • 専門用語の使用:使用する場合は誤った解釈を避けるため、用語説明を加える
  • 部品名称:統一した部品名称を使用する(部品表も参考にする)
  • 略語の使用:略語の後に(  )書きで説明するか、または脚注で説明をする
  • 数字の使い分け:アラビア数字を使用する(例:2番目、3回など)
  • 単位の整合:国内標準(SI単位)を使用し、mmとcmなど混在して使用しない
  • 短文の使用:一つの文には一つの内容を原則とし、50字以内を目安にする
  • 能動態の使用:受動態を避け、指示を明確にする
  • 肯定文の使用:否定文を避け、指示を明確にする
  • 重要事項」結論を先に記述し、理由や説明は後に記述する
  • 相互参照の使用:関連情報がある場合は、参照ページを明記する

ダイテックでは製造業のマニュアル作成改善を検討する際に、考慮すべきポイントをまとめた入門資料「安心と安全をカバーするマニュアルづくり 3つのポイント」「なぜ読むマニュアルから『見る3Dマニュアル』が増えているのか?わかるガイド」をご用意しました。本資料は、マニュアル作成改善をしたい方には必見の資料です。ぜひダウンロードいただき、ご覧ください。