トピック・タイトルを書く <title>

トピック・タイトル(title要素)には、トピックが扱う主題を書きます。読者が必要な情報を探しやすいように、読者が分かる言葉で、トピックの内容を具体的に表したタイトルを付けることが大切です。

読者の視点でタイトルを書く

読者が必要な情報を探すときに、トピック・タイトルは重要な役割を果たします。トピック・タイトルを書く上で最も大切なことは、「読者の視点」で書くということです。読者は「特定のゴール」を達成するためにマニュアルを参照します。したがって、どのようなゴールを達成するための情報がトピックに書かれているのか、はっきり分かるようなタイトルを付けなければいけません。「概要」、「機能」、「注意」といったタイトルは、不適切なタイトルの典型です。

情報の種類が分かるようにタイトルを書く

DITAのトピックは、読み手にとっての機能、目的により、コンセプト、タスク、リファレンスの3つのトピック・タイプに分類されています。各トピックが、これら3つのトピック・タイプのどれに該当するのか分かるように、トピック・タイトルの付け方を標準化することを推奨します。タイトルを見ただけでトピックの分類が分かれば、読者は効率よく必要な情報を探すことができます。

読む必要がないトピックが分かるようにタイトルを書く

使用している機種、装着しているオプション、システムや機器の動作モードなどの条件に応じて、いくつかのトピックの中から、条件に合致したトピックを選択して読む場合がよくあります。このように選択的に読むトピックのタイトルを書く場合は、「どのような場合に、どのトピックを読むべきか」がはっきり分かるようにタイトルを付けることが大切です。それぞれのトピックをどのような場合に読むべきかがはっきり分かれば、読者は不要な情報を読まずに済みます。

読むべきトピックを取捨選択しやすいタイトルの例

コンテクストを把握しやすいようにタイトルを書く

ブック指向のマニュアルは、読者が先頭から読み進めることを前提としており、その前提がタイトルの付け方にも影響していました。あるセクションで掲げた主題に対し、その下位のセクションで更に詳細を説明する場合、下位のセクションのタイトルから、上位のセクションの主題を省くのが一般的でした(下記の例を参照)。

ブック指向マニュアルのタイトルの例

トピック指向のマニュアルでは、検索、索引、リンクを使って、あるトピックへダイレクトにアクセスする場合に備える必要があります。あるトピックへダイレクトにアクセスしても、タイトルを見れば、そのトピックのコンテクストが把握できるようにタイトルを付けるべきです。上の例では、「PDFの出力をカスタマイズする」ための説明を、下位のトピックにブレークダウンして説明しています。この場合、以下の例に示すように、下位のトピックにも「PDFの出力をカスタマイズする」ためのトピックであることが分かるようなタイトルを付与すべきです。

トピック指向マニュアルのタイトルの例