マップを書く

DITAマップは、トピックへの参照の集まりから成る、トピック間の関係を定義するための文書です。DITAマップでは、ブック形式のマニュアルの目次と同様に、トピックの階層構造(トピックの親子関係)を定義できます。さらに、階層構造で表せない任意のトピック間の関係を表すこともできます。

DITA1.1では、2種類のDITAマップが定義されています。1つはDITA1.0のときからある基本DITAマップ(map要素)で、もう1つはDITA1.1で追加されたブックマップ(bookmap要素)です。基本マップは、表紙や前付けといった、ブック形式のマニュアルで必要なページを生成するための、構造や要素を有していません。ブックマップは基本DITAマップの特殊化により作られており、ブック形式のマニュアルで必要なページを生成するための構造や要素が追加されています。したがって、DITA文書からブック形式のマニュアルを作る場合は、ブックマップを使用すべきです。

基本マップとブックマップのどちらとも、ファイル名の拡張子は.ditamapでなければいけません。

マップ設計の考え方

マップは、伝えようとする情報の体系を表します。マップの上位階層に位置するトピックは、概要的なこと、一般的なこと、あるいは理解しやすいことを書きます。マップの末端に向かって、詳細なこと、専門的なこと、理解しにくいことへとトピックを展開していきます。

マップ作成の指針を以下に示します。

読者を迷子にさせないために、主題ごとに、すべての読者が必要とする情報を、詳細レベル(読者の知識レベル)に応じて、階層化して提供する

概要的、一般的、あるいは理解しやすい情報は、初心者のためだけにあるのではなく、上級者にとっても有用です。トピック指向のマニュアルでは、検索や索引によりダイレクトにトピックにアクセスした場合でも、そのトピックの位置付けを素早く理解できなければ困ります。例え上級者の人であっても、すべての情報について精通しているとは限りません。マップが上記の指針に従って作成されていれば、初心者の人でも、上級者の人でも、目次の中でのトピックの位置を見ることにより、トピックのコンテクスト(位置付け)を素早く理解できます。

トピックの集合タイプ

トピックの集合タイプには、以下の4つの種類があります。

トピックの集合タイプは、topicref要素のcollection-type属性により指定します。

トピックの下位に複数のトピックを配置する際は、トピックの集合タイプを考慮する必要があります。あるトピックの下位には、集合タイプが同じトピック群を配置すべきです。このようにトピックを配置することにより、読者がトピックの読み進め方を認識しやすくなります。

マップの標準化

作成したマップをレビューするとき、そのマップを別の製品の同種類のマニュアルに適用してもおかしくないか検討することが大切です。例えば、インストレーション・マニュアルのマップを作成したら、そのマップを他の製品のインストレーション・マニュアルに適用してもおかしくないかレビューします。このような観点でのマップのレビューは、マップの標準化につながります。標準化されたマップに基づいて作成されたマニュアルは、ユーザーが必要な情報を探すのを容易にします。