マニュアル作成業務の改善あるある事例を一気にご紹介!

序章

マニュアル作成の業務には、取材、原稿作成、設計チェック、イラスト作成、翻訳、DTP、印刷、配信といった工程があります。この工程を何度か経験すると、原稿やイラストを流用したい、設計変更が入るたびに発生する非効率な作業を回避したいと思うケースはないでしょうか。本記事にはマニュアル作成業務の改善事例を「流用編」「設計変更編」「翻訳編」にわけて一気にご紹介します。マニュアル作成の効率化を目指しましょう!

なぜマニュアル作成業務を改善する必要があるの?

製品マニュアルは、ユーザにわかりやすく、販売する国や地域の言語で、必要な情報が正確に記載されていなければなりません。また、製品に同梱されることも多く、品質を重視しつつ、短納期・低コストであることを求められます。

一方で、記載内容は専門性が高いため、多くの製造メーカでは設計者の方が実務の片手間に作業されていると伺います。そのため、実務に専念できず慣れない執筆作業にご苦労されている担当者様が多いのではないでしょうか。

当社は、「マニュアルは製品の一部」と考えます。改善あるある事例①~③をご参考にしていただき、ほんの少しでもマニュアル作成業務の改善や効率化のお力になればと思います。

マニュアル作成業務の改善あるある事例①(流用編)

マニュアルを作成する場合、目次構成が似ている他の製品マニュアルをコピーし、執筆されると思います。そうしたとき、コピーが複数回重なると、誤字や記述ミスが混入する際コピーしたすべてのマニュアルを見直し、修正する必要が発生します。本文のテキストだけでなく、イラストも同様です。コピー元の原稿やイラストはどれなのか、どこまでさかのぼって修正すべきなのか、改修が難しいケースも珍しくありません。

改善ポイントその1【共有コンテンツ】

原稿もイラストの場合も、複数の製品で共有できる文章(節や項)やイラストを作成し、マニュアルへ引用します。共有コンテンツにミスが発覚した場合も、一か所修正することで共有コンテンツを引用している全てのマニュアルに反映されるため、改修や確認の手間もなくなります。もちろん、原稿作成時に限らず、英文や多言語など訳文(節や項)、イラストも共有されれば更に品質や効率が良くなります。 イラストにおいては、イラスト内に言語を挿入しないことで、言語問わずイラストを共有することで更に効率が向上します。

改善ポイントその2【簡略化】

必要のない細かい描写は、あえて簡略化することもテクニックがあります。写真と違ってイラストの良い点は、製品毎に異なる箇所があってもそれを曖昧にすることで、多製品で同一のマニュアルへ流用することができます。

改善ポイントその3【CMS導入】

CMS(コンテンツマネージメントシステム)に継承機能があれば、逆引き検索などを利用する方法もあります。どこから派生したのか、CMSに機能が存在していた場合、修正の範囲を確認することができます。

マニュアル作成業務の改善あるある事例②(設計変更編)

製品マニュアルは、製品が完成し販売または輸出されるタイミングで同梱されるため、製品の開発から製品マニュアルは、製品が完成し販売または輸出されるタイミングで同梱されるため、製品の開発から生産スケジュールと並列で作成するケースが多々あります。製品の完成後に原稿作成開始ではないので、作成中に設計変更が入ると、その情報を作成中の該当マニュアルすべてに反映する必要が生じます。

改善ポイントその1【自動組版の導入】

DTPにかかる工数を極力避けるよう、改ページなど手作業の情報をあえて設けないことで自動組版導入を実現します。これまでは大量ロットの印刷が主流だったため、少しでも印刷代軽減目的でDTPによりページ数を抑える努力をしていました。しかし近年では、オンデマンド印刷が普及し、WEBサイトからPDFをダウンロードするスタンスにシフトしています。輸送コストと作業コストを天秤にかけることも考えると、ページ数削減のためのDTPは本当に必須なのか問われるところです。設計変更が入るたびに DTPをおこなうことで、きれいなレイアウトとページ数軽減は維持できます。しかし、 DTP介入により手作業ゆえのチェック&修正工数が膨らみ、費用的にも品質的にも良いものとは言えないのではないでしょうか。

改善ポイントその2【変数を利用する】

製品名や機能名はギリギリまで決まらない場合があります。特に大手メーカでは、開発工程では呼称で取り回し、量産手前で新機能の名称を盛り込む場合もあります。機能名公開前に執筆者がネットで検索をしてしまい、機能名が同業者へ漏洩することも防ぎたいところです。マニュアル作成の工程終了間際であっても、極力影響を抑える工夫になります。

改善ポイントその3【変更履歴を利用する】

エディタやCMSに機能がある場合は、日付や時間で定期的に保存し、校了毎に版管理を行い、常にバックアップすることで、いつでも再現可能な仕掛けを導入します。設計変更に限らず、原稿指示の取り下げや勘違いなどにより、以前のものに戻すよう指示がある場合があります。校了するまではいつでも戻せることが、リスク回避のひとつでもあります。

マニュアル作成業務の改善あるある事例③(翻訳編)

製品マニュアルの翻訳では、言語の置き換えだけでなく、国や地域ごとの訳文を作成します。翻訳を意識しない原稿やイラストの場合、翻訳後のチェックで大きな勘違いやミスに繋がるおそれが発生します。

改善ポイントその1【コールアウトで記載する】

言語展開では、和文より英文の方が文字列は長くなり、逆に中文は短いことが多いです。これにより、文章とイラストのバランスが崩れ、レイアウトの調整に工数を要するケースがあります。

そこでイラスト挿入の際には、コールアウトを利用します。イラストと付随するテキストを別々に記載することで、イラスト内での翻訳が無くなり、本文のテキストとなるため同一の辞書を利用できます。イラスト内の面倒なレイアウト工数も軽減できます。見出し目次や部品名称の説明によく見られます。

改善ポイントその2【ローカライズは正しい規格で記載する】

国際規格とはANSI、CE、GB、ISOなど販売する国や地域で異なり、マニュアルに記載する必要のある項目や内容が明記されています。設計担当の方がこれらの規格を理解し、内容を網羅するには大変難しいと思います。製品に対する訴えを保護するためにも、漏れなく速やかに対応するには、法規を理解した部署や業者にアウトソーシングするなどの対策をおすすめします。

まとめ

改善ポイントをご参照いただき、構成や記載ルールに従ったマニュアルを作成することで、これまでとは違うアップグレードされたマニュアルを実感して頂けるのではないかと期待しています。マニュアル作成業務を改善し、マニュアル作成の効率化を目指しましょう!

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

安心安全をカバーする・マニュアルづくりの3つのポイント
お役立ち資料
この資料は、マニュアル作成するうえで知ってもらいたい基礎的な情報を提供するものです。 「何故、マニュアルが必要なのか」「何に従って、何を書けばよいのか」「情報をどうやって伝えていくのか」等の情報を、初めてマニュアルを作成する人に向けて解説しています。 サンプル目次、ISO/IEC82079のチェックリスト、テクニカルライティングチェックリスト、見直し事例等、私たちのノウハ ウや考え方の詰まった貴重な資料です。是非、ご覧ください。
マニュアル作成