トピックのショート・デスクリプションを書く <shortdesc>

トピックのショート・デスクリプション(shortdesc要素)は、トピックの主文となる重要な文章です。また、ショート・デスクリプションは、トピックの末尾に生成される関連トピックへのリンク部において、リンク先のトピックの内容をプレビューするためにも使われます。ショート・デスクリプションを適切に書くことによって、オンライン・マニュアルのユーザビリティが飛躍的に向上します。

ショート・デスクリプションにどのような内容を書くべきかは、トピック・タイプによって異なります。本トピックでは、すべてのトピック・タイプに共通する、ショート・デスクリプションの書き方を説明します。

ショート・デスクリプションには、トピックの要約や、なぜそのトピックを読むべきなのかを書きます。ショート・デスクリプションは必須の要素ではありませんが、用語集トピックを除くすべてのトピックにショート・デスクリプションを書くことを推奨します。トピックが1つあるいは2つの文章で完結する場合は、それらの文章をショート・デスクリプションに書き、トピックの本文を省略しても構いません。

ヒント: トピックに書いたショート・デスクリプションを、マップに書いたショート・デスクリプションでオーバーライドできます。マップに書いたショート・デスクリプションの例を下図に示します。

ショート・デスクリプションはどこに表示されるのか

ショート・デスクリプションが表示される場所を、表示例を使って説明します。サンプルのショート・デスクリプションを下図に示します。

  1. トピックの主文(最初の段落)

  2. 関連トピックのトピック・プレビュー

  3. リンク・テキスト上にマウスカーソルを移動したときの吹き出し文字

こんなショート・デスクリプションを書いてはいけない

トピック・タイプに関わらず、以下の例に挙げるようなショート・デスクリプションを書いてはいけません。