マニュアル作成ツールで「読んでもらえるマニュアル」を作ってみよう!

マニュアル作成ツールで「読んでもらえるマニュアル」を作ってみよう!はこちら

読んでもらえるマニュアルを作成することは、単に文章やイラスト、デザインといったコンテンツを整えれば良いだけではありません。読み手の属性や知識レベルを意識することは最低条件として重要となるポイントですが、そもそも論として紙ベース・電子マニュアルといった、どのような媒体でマニュアルを提供するかも重要な要素です。新型コロナウィルスの蔓延により大きく変わった社会環境において、マニュアルに求められる役割も大きく変わりました。

読んでもらえるマニュアル作成~はじめに

マニュアルには業務マニュアル、操作マニュアル(取扱説明書)、教育マニュアルなど、用途に応じて様々なマニュアルがありますが、いずれの場合も、読んでもらえるマニュアルを作成しなければならない、という観点ではすべて共通しています。ここでは様々な角度からマニュアル作成時に気を付けなければならないことをまとめてみました。

マニュアル作成の前に・・・そもそもマニュアルって何?

なぜマニュアルが作成された?~マニュアル誕生の背景

マニュアル(取扱説明書)の歴史は浅く、産業革命後の19世紀にアメリカの生産会社に勤務していたフレデリック・テイラーが経営者から作業効率化を指示され、組立工の作業を細かく分析し、手順書を作ったのが最初と言われています。彼はその後、「課業管理・作業の標準化・作業管理のために最適な組織形態」をベースに、テイラー・システムとも称される科学的管理法を確立させました。それまでの伝承中心による情報伝達のみで十分であった時代から一歩進んでマニュアルが誕生したのは、かなり最近ということになります。

課業管理:労働者の課業(一定時間内になし終えるべき標準作業量)を決定し、生産活動を計画的に実施するための取り組み。

マニュアル作成の前に、マニュアルが果たす役割をおさえよう

産業革命による蒸気機関の登場とともに誕生したマニュアルですが、コンピュータの誕生と共に業務や製品・サービスは飛躍的に機能が複雑化し、マニュアルの重要性が高まりました。分厚いマニュアルが大好き、という方は少ないと思いますが、視点を変えて「操作を再現するための参考書」と捉えてみてはいかがでしょうか?
書かれてある通りに真似をすれば操作ができる、あるいは業務を進めることが出来るツールとしてマニュアルをしっかりと整備することは、世界的に見ても生産性の低い日本にとって非常に有意義なものとなるはずです。

せっかくマニュアルを作っても・・・マニュアルは見てもらってナンボ

マニュアルの目的や重要性は分かるけれども、分厚くそれなりに重量もあり、目当ての内容がどこにあるか分からないようなマニュアルを参照していちいち調べるのは苦痛ですよね。また、昨今の新型コロナウィルス感染症が蔓延している状況下、マニュアルを見るために出社する事も推奨されません。
そのような状況もさることながら、電子デバイスがこれだけ普及した上に長時間の操作に耐えられるようになると、電子化されたe-manualの方が検索性も高く、どこでも見ることが出来る上に重量も紙マニュアルよりも軽くなり、持ち運びも便利となります。
ただし電子端末が使えない状況も考えられるため、物理的に一番マニュアルを閲覧してもらえる最適解は「電子マニュアルをメインとするが、いつでも紙マニュアルをオンデマンド形式で準備が可能である」という解決策ではないでしょうか。

良いマニュアルを作ろう~マニュアルには様々な役割があります

良いマニュアルは誤動作を無くし、大事故を防ぐためのリスクヘッジツールにも。

マニュアルを作成する際に1つ大切な事を意識しておく必要があります。それは業務マニュアルよりも操作マニュアル、いわゆる取扱説明書の方が顕著かと思いますが、マニュアルに書かれていなかった操作をした結果、損害を被ったという理由で企業が訴えられるリスクは常に存在しているという事です。例えば、製品を梱包しているビニール袋に「お子様がかぶって遊ぶと窒息する恐れがあります」などと記載されている注意書きなどの類です。そこまで企業側はリスクヘッジを考慮しなければならない昨今、マニュアルの誤記のせいで通常とは異なる操作をした結果事故につながったりすると、企業経営に大きな打撃を与えることになります。

マニュアルでサポート業務を削減?調べたいことがすぐに見つかる、機能的なマニュアル

マニュアル作成において基本中の基本は、本来の目的である「調べたいことがすぐに見つかり、手順を再現することができる」ということの実現ですが、全ての機能や動作説明、トラブルシューティングの内容を網羅することは大変困難であるため、コールセンターなどのサポートセンターや担当営業などによるサポート体制が別途存在することが一般的です。操作方法がマニュアルに書かれているが、見つけることが出来なかった場合もサポートセンターや担当営業に問い合わせが行くことになるかと思いますが、調べたいことがすぐに見つかる、わかりやすいマニュアルになっていれば、営業やサポートセンターへの問い合わせを減らすことが可能です。昨今は電話による問い合わせの代わりにAIチャットボットの活用でオペレータ数を削減させようとする流れもありますが、それはそれでルール定義などの初期導入コストや、ルールのメンテナンスコストなどが発生するので、慎重に検討する必要があるでしょう。

動画マニュアルの作成も効果的~マニュアルのDX・マルチメディア対応

マニュアル作成において常に気を配らなければならないのは、一般消費者向けではなく企業向けの専門的な製品やサービスのマニュアルになればなるほど、書き手がライティングのプロではないエンジニア寄りになるということです。これが読みにくいマニュアルになってしまう一因にもなります。解決策として、しっかりマニュアルを設計し、ライティングを依頼する部分を明確にする手法(トピックライティング)があります。日本語は前後のコンテキスト(文脈・意味合い)が影響する傾向にあるので、なおさら体系的に設計=構造化することが求められます。さらにベストなのは、マニュアルをHTML化した上で必要に応じて動画を入れた、動画マニュアル(マルチメディアマニュアル)とすると、さらに伝わりやすくなります。今流行りのDX(デジタルトランスフォーメーション)対応にもちょっぴりつながります。

マニュアル作成の前に考えておくべきこと

マニュアルを使う人(読み手)は誰か?

マニュアルを作成する際は、だれが・いつ・どのような状況でマニュアルを使うか、という事を想定しなければ、本当の意味で活用いただけるマニュアルにはならず、それは自己満足のかたまりとなった、いわゆる「誰も読まないマニュアル」を意味します。読み手のスキルレベルをどのあたりで定義するかを考慮することで用語の統一も図れますし、紙ベースで見られる事が多いのか・タブレットなどで閲覧される事が多いのか・あるいは両方ありえるのか、といったことから、読まれる地域を考慮する事で、対応言語は日本語だけで良いのか?日英で良いか?あるいはさらに対応言語を増やす必要があるのか?といったことまで考慮すべきでしょう。

マニュアルを作る人は誰か?(人数、スキル、現場部門/専門業者への依頼)

マニュアルの読み手を想定したら、次は誰がどのようにしてマニュアルを作成してゆくかを考える必要がありますが、業界や用途によってマニュアルが抱える課題は様々です。業務マニュアルであれば、業務の急拡大などに対してマニュアルが整備されておらず、オペレーションの平準化が追い付かないという事がよくあります。ソフトウェアベンダーやITサービスベンダーでは新製品・サービスのライフサイクルが早いため、リリースペースに合わせたマニュアルのスピーディかつ頻度の高い改訂が求められます。製造業の場合は社内もしくは特定の制作会社、といった形で、既にマニュアルの制作体制が存在する事が一般的ですが、属人的な制作スタイルからの脱却とともに、担当者の高齢化・納期短縮・制作コスト削減などの課題に対して考慮する必要があるのではないでしょうか。

脱炭素社会に向けたマニュアルとは?~紙媒体・PDF・電子マニュアル

脱炭素社会の流れとともに、マニュアルも本格的にペーパレス化を検討する企業が増えてきました。しかしながら、電力事情や通信環境が整っていない場所や、現地販社などへの納品物という意味合いで、紙ベースのマニュアルを用意する必要性もまだまだ存在します。従来型の紙マニュアルを全てやめて、電子マニュアル一本にすることは大変勇気がいることです。あるいは印刷しやすいPDF版のマニュアルを用意しなければならない状況も多々あります。特に操作マニュアル(取扱説明書)において電子マニュアル一本とされる企業は、SDGs(Sustainable Development Goals:持続可能な開発目標)への対応意識も高い、一般消費者向けの製品やサービスを提供されている企業が多い傾向にあります。これからのマニュアルの利用シーンを考える上で、脱炭素社会やSDGsは大きな影響を及ぼすことでしょう。

マニュアルを作成してみよう!~まずは構成から

マニュアルは目次から~章項節の構成を設計し、体系的に読みやすくする

上手な作文をつくる時間配分の心得として「構想50%、実際に書くのは50%」とよく言われますが、マニュアル作成についても段取りが重要です。マニュアルの場合、本文からいきなり書きだすのではなく、今まで記載した内容をふまえて構成をしっかり先に考えてから作成にとりかかると、いわゆる「読みやすいマニュアル」となります。マニュアルの構成を考えるということは、目次を考えるという事とほぼ同じと考えてもらえればと思います。方法としては大項目を中心にマニュアル全体をイメージしながら、中項目~小項目を並べてゆく流れが一般的ですが、イメージがつかない場合は、評価が高い他社マニュアルの目次構成を参考にする、あるいはメーカーやベンダーが推奨するテンプレートに合わせてしまう方法がリーズナブルかつ有効です。費用はかかりますが、マニュアル構成部分のみ、プロにコンサルティングをお願いするという方法もあります。

テクニカルライターの割り当て~社内エンジニア・専門業者など

マニュアルの目次構成がしっかり出来ていれば、次はマニュアルの中身を作成してゆく流れ、つまり本文を記述してゆくことになります。マニュアルの構成がしっかりなされていれば、ライティング箇所が適切な形で分割されているはずなので、社内・社外を問わずライターに求めるスキルセットを下げることが出来ます。一般的に社内担当者であれば内容はしっかり記述してもらえると思いますが、ライティングの専門家ではないので言い回しや用語のゆらぎなどはライティング依頼側で補正する必要があります。外部の専門家に依頼するのであれば、ライティング自体はプロであるため心配は無いかと思いますが、対象製品やサービスの事をどれだけ理解されているかがカギになります。場合により技術トランスファが別途必要となる事も想定すべきでしょう。

図表情報を図とテキストに分離~表化によりメンテナンスコストを極小化

マニュアル作成において必須ともいえるコンテンツが、図表や挿絵です。ソフトウェアやITサービスのマニュアルであれば単なる画面キャプチャだけで済むこともありますが、画像に加えて引き出し線とテキストがセットになっている事が多いのではないでしょうか。改訂が不要の画像であればPhotoshopやillustratorなどのツールで作成し、pngなどで出力したものを活用すれば良いですが、テキストの変更が想定される場合はPhotoshopあるいはillustratorで画像自体の改訂が必要となります。これらの手間を防ぐ手法としては、テキスト情報は表化して外出しすることで、テキストの変更は表内のテキスト差し替えのみで済ませることができます。ちなみにこの手法をベースにすると、マニュアルの多言語化を行う場合にも効果を発揮します。画像内に訳文テキストが存在する場合、原文と訳文ではたいてい文字数が異なりますので、その違いを画像上で調整する必要が生じますが、そういった作業も不要となり、全ての言語のイラストを一つで済ませることができます。

マニュアル品質を左右する、用語や単語のゆらぎ問題~多言語マニュアルでは影響大!

マニュアル作成の中でも、本文ライティングを社内エンジニアなどの技術者に依頼した場合は、どうしても用語や単語のゆれが発生します。例えばMS Wordを作成ツールとして使う場合、たとえば「サーバ」と「サーバー」といった簡単なゆらぎはアラートを出してくれますが、「パソコン」と「PC」のアラートが出るようにするには、事前にMS Wordに辞書登録する必要があります。個別に単語登録されたとしても、複数名で手分けしながらライティングを行う場合は、単語登録のルールを定義したのち、ライティング担当者全てに展開する必要があります。MS Wordに限らず、デスクトップツールの場合は、辞書に追加される情報はライティング担当者全てに展開し、常に最適化しておかなければなりません。CMS(コンテンツ管理システム)などのような、マニュアルコンテンツを一元化する仕組みを導入した場合は、辞書情報も集約できるため、手戻りなどの作業を減らすことが可能です。特に多言語マニュアルの場合は、用語や単語がゆらぐことにより、原文マニュアルの品質だけではなく、そこから派生する訳文でのゆらぎの影響がさらに大きくなるため、翻訳品質や翻訳コストに影響し、ひいてはマニュアル全体の品質に影響します。

読んでもらえるマニュアルを作成するには~マニュアルのDX対応

マニュアル作成時の考え方も変化~紙マニュアルと電子マニュアルの共存

マニュアル作成の手法も変化が生じています。従来は紙媒体が意識されていたマニュアルですが、紙ベースのマニュアル、あるいはDTPで作成後、PDF出力されたマニュアルは、コンテンツの連続性が高いブック志向になりがちです。一方HTMLベースの電子マニュアルは、ページが物理的に分断されているため、前後のコンテキストを意識してしっかり区切りながら作成してゆく必要があるため、従来のDTPによるマニュアル作成手法とは少し異なった考え方が求められます。HTMLベースのマニュアルは必要な箇所のみページ単位で読み込むことが出来るため、一気に全データをダウンロードしなければならないPDFと比較した場合、ページ数が多ければ多いほど閲覧性は高まります。
閲覧デバイスが進化したことに伴い、電子マニュアルの普及が進んでいますが、新型コロナウィルスの蔓延によるテレワーク推奨の流れは、アフターコロナの社会であっても、ある程度は残ると言われています。そうすると、紙ベースの業務手順書などのマニュアルを閲覧するためにわざわざ出社するという事を回避しようという流れが今後も続くことでしょう。ペーパレスの流れは、今後取り組みが本格化する脱炭素社会にも沿った取り組みとなります。

電子マニュアルと紙媒体の両方を用意する場合は、DTPデータを流用して作成?

マニュアル作成側から考えてみましょう。DTPで作成された過去資産となるマニュアルを生かしつつ、電子マニュアルの配信も新しい取り組みとして開始することを考えた場合、電子マニュアルの情報源となるDTPデータが存在するとはいえ、従来形式のマニュアル作成に加えてさらに電子マニュアルの作成を行わなければならなくなります。このような作業量の増加を回避する方法として、コンテンツとレイアウトを分離することで、マニュアル作成を一度で済ませてしまい、紙媒体向けの組版と電子マニュアルをシステム的に同時出力する仕組みが効果的です。導入コストはかかりますが、一度導入してしまえば、後はメンテナンスコストのみで改訂によるマニュアルの更新も可能となりますので、「紙ベースのマニュアルを一気にやめることは避けたいが、電子マニュアルを中心に据えて考えたい」という場合はピッタリの選択肢となります。例えば当社のマニュアル作成システム「PMX」では、マニュアルのHTML化を進めると、副次的にPDF出力も出来るようになります。もちろんマニュアルの新規作成時もワンソースでHTML化とPDF組版の両方が実現できます。

文章のみでは伝えにくい~動画も取り入れた、マルチメディアマニュアルに

電子マニュアルの長所として、動画を入れることが出来るという点があげられます。特に日本語はあいまいな表現を得意とする言語ですので、文章での記述ではなく動画コンテンツによる説明は、伝えたいことを的確に伝えることができるため、非常に効果的です。動画作成や容量・通信速度や通信費などの問題は存在しますが、次世代通信規格である5Gの普及にともない、動画マニュアルの導入は進んでいくものと思われます。むろん社内閲覧やWi-Fi環境が保証されている場所であれば、動画マニュアルの閲覧環境としては全く問題ありませんね。

DX化を進める際に、既存コンテンツはどうする?~今後のマニュアル作成に役立ちます!

レガシーデータは廃棄せず保管~最低限PDFにしておく、あるいは従来通り改訂

マニュアルのDX化を進めるにあたり、考えなければならないのが、MS WordやInDesign、FrameMakerや、そのほかのDTPツールなどで作成されたレガシーデータです。マニュアルには多かれ少なかれ更新作業が発生することが想定されますが、たとえ電子マニュアルに一本化することを目指す場合であっても、改訂頻度が非常に少ないマニュアルは、DTPなどの従来通りの改訂方法で更新を行ったほうが、コストや品質面から見て有利となることもあります。紙のみしか存在しない場合は、とりあえずスキャンして保存しておくと、図表などはそこから切り取って新規マニュアル作成時などに活用することも可能ですので、なにはともあれ保存はしておきましょう。

マニュアル作成システム導入時のデータ移行費用はそれなりにかかります

マニュアル制作~管理~配信までを行うコンテンツ管理システムの導入を行う際には、既存のレガシーデータを初期データとしてうまく活用できる場合があります。ただし、新システムはレガシーデータを作成したツールとは別の仕組みとなりますので、コンテンツ移行時にテキスト情報や図表自体は欠落しないにせよ、多かれ少なかれレイアウト情報は全て継承されないことがほとんどです。コンテンツを移行させた後で個別にレイアウト調整を行う事も可能ですが、ここは思い切って、テキスト情報などを新システムが保有するテンプレートに流し込み、マニュアルの体裁を一新させるという流れをお勧めいたします。新システムの場合、たいてい新しいテンプレートが付属しており、それは最新のデバイスを意識した電子マニュアルに対応されているものがほとんどですので、マニュアルの読み手に対しても高い検索性や閲覧性を提供できることになります。

独自のテンプレート作成は、薄めのマニュアル一冊、あるいは一章を移行がてら実施!

既存のテンプレートを活用せずに、できるだけ既存のレイアウトを流用したテンプレートを独自に設計することも選択肢の一つとしてあげられます。その際は、ページ数が少なめのマニュアル一冊、あるいは一章のみを作成し二章以降は構造化されたスケルトンのみ準備するといった形で、見本となるテンプレート作成を目指した方が、その後続くマニュアル作成全般の作業効率を上げることができます。テンプレート化さえしてしまえば、後は社内の空き時間を活用しながら片手間でコンテンツ移行を進めることも可能ですが、当社では自社オフショア拠点をフィリピンに有しておりますので、コンテンツ移行の外注化を検討される場合はぜひご相談ください。

マニュアルのメンテナンス~更新や改訂時における問題

属人的なマニュアル作成フローでは、改訂品質がいずれ急に悪化する

マニュアルには改訂作業が発生することが多々ありますが、作業自体は必ず人が実施することになります。対象のマニュアルにおいて、ノウハウを有している社内担当者あるいは外部業者であればスムーズに改訂を行う事が可能ですが、担当者の退職や離職、あるいは外部業者内での担当変更やキャパシティの調整などにより、今まではおおざっぱな形で更新内容を伝えても的確に反映されていた改訂作業が、改訂する人が変わったことにより異なった更新内容になるケースはよくあります。原因はマニュアルの新規作成や改訂が俗人化されているからに他ならないのですが、対策としては極力属人性を排除し、編集やライティング作業を平準化することにより回避することができます。

マニュアルが構造化されていれば、改訂工数は必要最小限

改訂時の属人性を排除するには、分担作業によりマニュアル作成が実施されていることが大前提となります。言い換えれば、部品化されたマニュアルの複数箇所を人が入れ替わっても作成あるいは改訂が可能となっていれば属人化を防ぐことはできますし、なにより手が空いている人でライティングを済ませることが出来るので、うまく空き工数を活用することで、結果的にマニュアル作成や改訂の工数を最小限に抑えることが可能となります。それには司令塔となる編集者が重要になってきますが、解決策としては、編集者に必要とされるワークフローやバージョン管理などの機能が備わっている、マニュアル作成用のCMSを導入することが効果的です。

多言語マニュアルの場合、ソース言語だけではなく派生コンテンツも修正要

多言語で作成されたマニュアルを改訂する場合は、ソース言語で作成されたマニュアル改訂に加え、ほかの言語で作成されたマニュアルに関しても改訂による内容の更新が発生しますので、脱・属人化を進めることはさらに効果を発揮します。多言語マニュアルの中でも、日本語マニュアルから複数言語のマニュアルに展開されている場合もあれば、日本語マニュアルから英語に翻訳したマニュアルをソースコンテンツとして、複数言語のマニュアルに派生させた形での運用もあるかと思います。いずれの場合であっても、多言語マニュアルのスムーズな改訂を行うためには、マニュアル作成プロセスの平準化を行っておくことは重要です。

最後に

当社では、皆様のマニュアル作成やDX化推進をサポートする製品やサービスをご用意しております。これから取り組みを検討されようという方も含め、ぜひ気軽にお問合せください。

御相談、ご質問はこちら

サービスご案内資料や、特別資料「マニュアル作成の効率化とコストダウンを実現するポイントとは? 」がダウンロードできます。

最新事例の公開情報や、イベント・セミナー情報をお届けします。

pagetop ボタン
©2003 CyberTech corporation ltd. All Rights Reserved.