DITAによるドキュメンテーション

DITAは、Darwin Information Typing Architectureの略で、製造業やソフトウェア業界におけるマニュアルやトリセツ(取扱説明書)をはじめとする技術情報を効率良く制作・管理・配信・再利用するために策定されたXMLベースのアーキテクチャです。ここではDITAによるドキュメンテーションの概要と仕様、制作環境について解説します。

DITAの概要と普及の背景

DITAは、Darwin Information Typing Architectureの略で、製造業やソフトウェア業界におけるマニュアルやトリセツ(取扱説明書)をはじめとする技術情報を効率良く制作・管理・配信・再利用するために策定されたXMLベースのアーキテクチャです。

特に、グローバルに展開する大手製造業では、DITAを採用する企業が増加しています。その理由は、自動車やパソコン、プリンタ、エレクトロニクス製品など消費者向け製品から、建機、工作機械、通信機器やソフトウェアなど企業向け製品まで、製品のライフサイクルの短縮化やグローバル化の進展、さらには安全基準や規制の適用厳格化により、製品のトリセツ(取扱説明書)や保守点検マニュアルといったドキュメントの重要性が高まってきたためです。DITAによるドキュメンテーションは、以下のようなマニュアルやトリセツ(取扱説明書)を編集・管理する上での課題を解決します。

  • 編集時に同じ内容を何度もライティング(コピペ)する必要がある。
  • ファイル単位の版数管理になってしまう。
  • 改訂時に、差し替え箇所が特定できず、差し替えミスが発生する。
  • ファイル単位で翻訳するため、翻訳コストと翻訳管理コストが増大する。
  • 編集者と校正者でドキュメントの共有がしにくいため校正作業が非効率。
  • ドキュメントの量が増えると検索が遅くなり、欲しい情報が手に入らない。
  • 紙のマニュアル専用のデータのため、Webマニュアルは一から作り直さなければいけない。

DITAは、このような技術ドキュメントの課題を解決するための手法としてアメリカで提唱、規格化され、大手航空機会社の保守マニュアル等、複雑な手順の記載が必要な膨大なドキュメントで実績をあげています。日本でも大手機械メーカー、家電メーカー、半導体メーカーが積極的にDITAを取り入れ、技術ドキュメントの効率的な制作と管理運用を実現しています。

DITAの技術と仕様

DITAは、2017年9月現在、Version1.3がリリースされています。日本国内のDITAの普及啓蒙は、DITAコンソーシアムジャパンが中心となって活動を行っています。このようにベンダーだけでなくユーザ企業も含めた活動により、DITA導入や運用のノウハウの蓄積が進み、導入事例の公開も少しずつ増加しています。

DITAは、XMLをベースにしたアーキテクチャであり、トピック(情報の内容)とマップ(情報の構造)という2種類のデータで構成されています。トピックはその目的別に「コンセプト型トピック」「タスク型トピック」「リファレンス型トピック」「グロッサリー型トピック」の4種類に分類されます。「コンセプト型トピック」は、製品の説明文等を記述する際に使用します。「タスク型トピック」は、取り付け手順や作業手順、工程などを記述する際に使用します。「リファレンス型トピック」は、別のトピックへ参照する際に使用します。「グロッサリー型トピック」は、用語集を作成する際に使用します。

基本的には、DITAを使ってマニュアル(取扱説明書)や技術文書を作成する場合は、上記いずれかのトピックタイプに当てはめていけば良いのですが、DITAは、「特殊化」という概念で、これらを派生させて個別のトピックタイプを記述することを可能にしています。

DITAドキュメントの編集・管理

DITAドキュメントの編集エディタには、様々なタイプのエディタがあります。その中でも「Oxygen(Syncro Soft社)」「XMetaL(ジャストシステム社)」などのXMLエディタを使用するケースが一般的です。その他、拡張機能やアドインでDITA編集機能を提供するDTPソフト「FrameMaker XML Author(アドビシステムズ社)」や、DITA対応CMS(コンテンツ管理システム)に組み込まれた簡易DITAエディタなどがあります。

では、エディタで編集されたDITAファイルは、どのように管理されているのでしょうか。

DITAのトピックやマップ等のDITAドキュメントをファイルベースする管理する際には、「Git」や「Subversion」などのバージョン管理ツールや、「Dropbox」「Box」のようなファイル共有サービスを使用する場合が多いようです。DITAファイルをデータベースで管理できるDITA対応CMSは、海外製品が中心ですが、顧客側の導入コストや導入にかかる業務負荷が非常に高い事から、日本国内では十分に普及しているとは言えません。

最後に、DITAドキュメントを出力するためのしくみとして、「DITA Open ToolKit」があります。「DITA Open ToolKit」は、DITAドキュメントをPDFやXHTML、DocBookなどに出力する事ができます。IBMで開発されたこのシステムは、その後オープンソースとして公開されている事から、エンドユーザだけでなく、DITA関連ツールやシステムを開発している企業が採用し、広く普及しています。

御相談、ご質問はこちら

お気軽にご相談ください

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

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

pagetop ボタン