連載
» 2016年08月09日 10時00分 公開

“バケツリレー”によるマニュアルづくりから脱却するための手法とは製造業ドキュメンテーションの課題(2)(3/4 ページ)

ダイナミック・ドキュメンテーションの事例

 ダイナミック・ドキュメンテーションのコンセプトを実現する事例をご紹介しよう。著者が代表を務めるDITAコンサルティング法人のアートダーウィンが、ある製造業の顧客に提案し、実現したものである。

 この企業はそれまで、DTPツールの「FrameMaker」によってマニュアルを制作してきたが、制作/翻訳コストの削減とサービスレベルの向上を狙ってDITAによる制作環境に移行した。移行に伴って制作ツールもFrameMakerからDITA編集ツールの「XMetaL」に切り替えている。そして、この移行を契機として、安全のための警告注意文(以下、注意文)を、マニュアル掲載する局面でダイナミック・ドキュメンテーションを実現した。

 製造業では注意文をマニュアルの適切な箇所に正確に記載することが極めて重要である。この企業では、そうした注意文は品質保証部門が「Excel」で管理し、マニュアルやカタログ、Webサイトの制作部門に提供していた。

 制作部門はそのExcelファイルを見て転記するのだが、作業負担が大きく、転記ミスや記載漏れなどのヒューマンエラーが発生することが多々あった。さらに、品質保証部門がオリジナルの注意文を改訂した際、それを既存の制作物に反映する必要があるが、その周知徹底は難しく、改訂漏れが多かった。

 こうした問題を解決するため、注意文をExcelでは無くリレーショナルデータベースで管理することにした。注意文のデータベースを構築したわけである。マニュアル制作部門はXMetaLでマニュアルを編集中に、掲載すべき注意文をデータベースへ検索する。ヒットした注意文はDITA形式に変換され、そのままマニュアル内に挿入される。マニュアル編集者が注意文を書くのではなく、データベースの情報がマニュアルコンテンツとしてダイナミックに組み込まれるのである。

 ダイナミック・ドキュメンテーションがどんなものかイメージしていただけるよう、この企業での編集例を示す。マニュアルを編集中に、掲載した工具について何らかの注意文が必要かどうかをデータベースで検索し、該当するものがあればそのまま文中に組み込むという流れである。なお以下では、守秘義務の関係から実在のデータとは異なるもので説明している。

ダイナミック・ドキュメンテーションのイメージ(1) (1)XMetaL上で「注意文を挿入」をクリックして注意文データベースにアクセスする
ダイナミック・ドキュメンテーションのイメージ(2) (2)条件を指定して検索する(ここでは工具で使うモンキーレンチに関わる注意文を探す)
ダイナミック・ドキュメンテーションのイメージ(3) (3)検索でヒットした候補からマニュアルに挿入したい文言を選択する
ダイナミック・ドキュメンテーションのイメージ(4) (4)選択した注意文に関する詳細な情報を確認する
ダイナミック・ドキュメンテーションのイメージ(5) (5)「挿入」をクリック、カーソル位置にその注意文が挿入される

 この一連の処理は、XMetaLのSDK(開発キット)を使って、アートダーウィンでプログラム開発した。ただし、この原理はシンプルである。データベースから取ってきたデータに、以下のようにDITAのタグをつけてマニュアルのDITAコンテンツに組み込んだだけである。

DITAのタグの挿入例

 同じ仕組みを使って、今度は生産管理部門で持っている工具情報データベースに検索をかけ、該当する工具のデータとそのイラストをマニュアルに挿入する。

工具情報データベースの活用(1) (1)XMetaL上で、工具データベースにアクセスして「モンキーレンチ」に関係する工具を検索し(A)、ヒットした工具(B)から、該当する工具の詳細項目(C)を表示し、マニュアルに掲載する項目を選択する。
工具情報データベースの活用(2) (2)選択した項目の情報にDITAの<dl>タグがつけられマニュアルに挿入される。
工具情報データベースの活用(3) (3)最終的には、このマニュアルコンテンツを自動組版にかけてPDF出力する。

関連キーワード

マニュアル | 製造業


Copyright © ITmedia, Inc. All Rights Reserved.