はじめに

本書は、DITAコンソーシアムジャパン ライティング・ガイド制作部会の有志により執筆されています。本書は、一般の書籍のように、経験豊かなエキスパートが、十分な構想を練って執筆した訳ではありません。DITAについて学びながら、その過程で蓄積したノウハウを文書化したものです。「いっしょに学びながら、ノウハウを共有する」ことを前提に執筆していますので、その趣旨をご理解いただいた上で、本書をご利用ください。

本書の目的

初心者にDITA文書の一般的な書き方を示し、DITAによる文書作成の理解を促進することが本書の目的です。

DITAはテクニカル・ライティングのベスト・プラクティスを踏襲して設計されていますが、それでもなお、様々な執筆の仕方を選択する余地があります。DITAの柔軟性はDITAの強みの一つですが、初心者にとっては柔軟に書けることがマイナスに働く場合があります。まずは、本書を参考に一般的なDITA文書の書き方を学び、DITAによる文書作成の基礎知識を固めた上で、各社にあった応用方法を定めることを推奨します。このような理由から、本書では、どこの企業にも共通する基本的な執筆ルールについてだけ言及しています。

重要: 本書の目的は、DITAのタグ(要素や属性)の使い方を解説することではありません。執筆方法の説明の一環としてタグの使い方にも触れますが、本書で解説するのは一部のタグの、典型的な書き方や使い方だけです。DITAのタグ・セットの完全な解説については、DITA Language Specificationを参照してください。

対象文書

本書では、ソフトウェア、ハードウェア、サービス等のマニュアルを執筆することを前提に、DITA文書の書き方を説明しています。なぜなら、DITAの最も典型的な用途がマニュアルの作成だからです。DITAを使って、マニュアル以外の文書を作成する場合、本書の説明が適切でないことがありますので、注意してください。

対象読者

本書は、以下のような知識や経験を持つテクニカルライターを対象読者として想定しています。

本文中の画面キャプチャについて

本文の中で、DITAの書き方や文書構造を示すために、XMLエディタの画面キャプチャを挿入しています。使用しているXMLエディタは、SyncRO Soft Ltd.の<oXygen/>® XML Editor version 11です。<oXygen/>® XML Editorを使用したのは、執筆者の好みであり、DITAコンソーシアムジャパンが同ツールを推奨している訳ではありません。