マニュアル最適化の第一歩は?
投稿日:2023年10月25日
カテゴリー:豆知識
投稿者:
S山
取扱説明書、据付説明書、作業マニュアル、施工説明書・・・
どんなマニュアルでも3つの要素に分解ができることはご存知でしょうか。
それは、テキスト・イラスト(画像)・表です。
この3要素を組み合わせて、レイアウトして情報としてわかりやすく読ませるものにしていくのがマニュアル制作の腕の見せ所です。
では、実際そうして作り上げたマニュアルから別のマニュアルに展開するときに皆さんはどうしているでしょうか。
おそらく多くの方がやっているのが「データの複製」です。
ワードであれ、DTPデータであれ、デジタルデータは簡単に複製ができます。いとも簡単にできてしまうために、そのことで生まれる弊害については案外気に留められることがありません。
その弊害とは「亜種を生む」ということです。
データ複製の罠
テキストであれ、イラストであれ、表であれ、複製して編集することにより、ちょっとだけ違うものが多数生まれてしまいます。そうした表現のちょっとした違いで生まれる文章を「揺れている」と表現することがあります。
表現が「揺れる」ことによって、どういった問題が起きるでしょう。
実際にはマニュアルの使用者は複数のマニュアルを見比べるわけではないので、その違いには気づかないでしょう。
しかし、制作側には大変なデメリットが生じます。
それは「どっちが正しいの?」問題です。統一が取れていないと確認にコストがかかるのです。
こっちではこう書いてあるけど、こっちでは違うふうに書いてあるとなると判断がつきません。そのために確認に費やすコストがかかってしまうのです。統一されているに越したことはありません。
では、亜種を生まないためにはどうしたらいいでしょうか。
データを複製しないことです。
データを複製せずにどうやって新しいデータを作るというのでしょうか?
データを一元管理すればいいのです。
いまが一元管理をするタイミングかも
複製するとAを複製したBはBとして独立してしまいます。
参照するとAもBも同じCを参照することで、Cを編集するとAもBも更新されるようになります。
単純に複製した場合、後から情報が更新されたときはAもBもそれぞれ修正しなければなりません。2つの事例では大したことではないですが、これが増えていくと管理できなくなり、修正のコストも増えていくばかりです。
マニュアルを要素に分解して管理するという方法が効果を生むのは、ある程度マニュアルの本数が多い場合です。
なので最初からそうした危機意識を持って取り組まれる企業は少ないのですが、いつ要素分解して管理するかという発想に切り替えるかはとても重要なポイントです。
要素を一元管理することによってもたらされるメリットとしては、品質管理や維持のしやすさ、制作時の確認コストの削減が挙げられます。
一方、デメリットとしては管理コストが増えるというのがあります。
「ライブラリを使う」という考え方
少し飛躍しますが、プログラミングの世界では「ライブラリ」という概念があります。
PythonであれPHPであれ、どんなプログラミング言語であってもライブラリを使わずにコーディングすることはあまりありません。
ライブラリとは、プログラムにおいてよく利用される機能を切り出して、再利用しやすいようにまとめたものです。
ライブラリを使うことによって効率的にプログラミングができることは、もはやどのプログラマーも否定しないでしょう。
ドキュメントにおいても、このライブラリのような考えが有効です。
DTPでマニュアルを章ごとに区分けして別ファイルにする。
制作するときは、その区分けしたデータを読み込む。
どうしても枝分かれが必要なところがあれば、そこだけ亜種を作る。
こうしたやり方で「ライブラリ」を管理していくことで、修正の場合に影響を限定的にもでき、作業も分割することができます。
効率的で、問題の少ないマニュアルを制作していくためには、全体最適化の考えが欠かせません。
データの揺れに課題を感じている方はぜひご検討ください。