DITAとトピックライティング、導入するならどちら?

ここでは、DITAに適したドキュメントとトピックライティングで十分効果が得られるドキュメントの要件について、その違いを解説します。DITAでは、ドキュメントを製品の設計製造プロセスの成果物として位置付け、ドキュメントの制作や改訂の現場に対して厳密な運用を求めます。一方でトピックライティングは、構造化・部品化のルールを守れば、専門知識が無いチーム内でもドキュメントを編集する事ができます。

DITAに適したドキュメントと導入フロー

DITAは、航空機や電子機器、自動車、半導体、エンタープライズ向けのソフトウェア技術書など大規模な技術ドキュメントの制作効率化に効果を発揮します。

DITAによるドキュメンテーションフローは、ドキュメントを製品の設計製造プロセスの成果物として位置付けるため、設計部門や品質部門など、ドキュメント制作部門以外も巻き込んだ大規模なプロジェクト体制を構築する必要があります。まず、トピックの執筆は、DITAの仕様を理解したエンジニアが行い、CMSやGitなどの共有環境にトピックをアップします。執筆したトピックに対して、管理者が、仕様通りにトピックが書かれているかどうかのチェックと共に、版数の管理や用語チェックなどを行います。このように、DITAのドキュメント制作フローでは、関係者全員がDITA仕様を正しく理解する事が求められます。

DITAは、従来のように設計部門が執筆した仕様書や設計書をテクニカル・ドキュメントのライターがライティングし直し、DTPで印刷物向けのドキュメントを作成するというプロセスとは一線を画すため、組織改編を前提とした、数年単位のプロジェクト構築期間と、DITAの仕様も含めたメンバーの教育を十分に行う必要があります。つまり、DITAドキュメントの制作プロセスへ移行するには、十分な予算と期間が必要となります。

トピックライティングに適したドキュメントと導入フロー

DITAの元となる考え方であるトピックライティングのみの導入にとどめた場合は、DITAほど厳密な運用フローを求めませんので、業務用設備機器や電子部品、輸送機器やソフトウェアのマニュアルなど、小~中規模の技術ドキュメンテーションの効率化にも効果を発揮します。また、トピックライティングは、多言語展開を行っている・Webマニュアルも同時に提供している・改訂の頻度が多いなどの要件において、1冊のボリュームが少なくても、十分に費用対効果を上げることが可能です。

トピックライティングは、ドキュメントの制作単位をページ単位からトピック単位に切り替えることが必要条件となりますが、DITAのような設計製造プロセスとの一体化や、大規模なプロジェクト体制の構築、DITA仕様を理解するための教育などは必要とされません。トピックライティングでは、従来のマニュアル制作フローや体制をそのまま維持しながら、ドキュメントを効率良く作成することも可能にします。テクニカル・ドキュメントのライターは、執筆環境をDTPソフトやMS Wordからトピックライティングが可能なエディタに変更するだけで良く、ドキュメントの管理者も、トピックが最低限必要なルールに則って作成されたかどうかだけを確認すれば良いのです。

このように、トピックライティングは、DITA導入にかかる費用の数十分の一の費用で、構造化ドキュメントの制作運用フローを構築することが可能となります。

DITAとトピックライティング、どちらが効果的?

マニュアルやトリセツ(取扱説明書)制作の構造化の検討段階では、まずDITA導入を検討するケースが多く見られます。しかし、そもそもDITAの導入には、組織改編と長期的なプラン作りが必須条件であるため、様々な観点から慎重に判断することが重要であり、他社の事例をそのまま自社に適用するような安易な導入は避けるべきです。

自社の製品の特長や、顧客ニーズ、マニュアルやトリセツ(取扱説明書)制作や管理上の課題をしっかりと抽出した上で、DITAの導入から運用、維持するための十分な予算を関係部門と調整したうえで確保し、DITAを理解するための教育(意識改革)と技術面のトレーニングにも時間を十分にかけて実施することが必要です。さらに、DITAで最も重要なのは、「IA(Information Architecture)」と呼ばれる情報設計です。大量のドキュメントを専門家が分析し、構造化や部品化の要件を決めるこのIAプロセスは、最短でも6カ月~1年以上必要と言われています。

これに対して、トピックライティングのみの導入を進める場合は、トピックライティングの教育と簡易型IAを行い、その後、3か月程度のPOC(Proof Of Concept)や運用検証・トライアルプロジェクトを実施するような、スモールスタートで始めることができるのが特長です。もちろんDITAの再検討時にはトピックライティングにおけるPOCはムダにはなりませんので、DITA導入を検討する企業も、まずはトピックライティングによるドキュメンテーションから始めてみることをお勧めします。

御相談、ご質問はこちら

お気軽にご相談ください

製品カタログ・セミナーでの講演資料など、豊富な資料がダウンロードできます

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

pagetop ボタン