参照トピックタイプ

参考情報は、表やリストのような、簡単にスキャンできる形式であるべきです。辞書や百科事典の項目に似ています。

# Title (a noun, like "Pipeline settings" or "Administrator options")

Introductory sentence.

| Setting | Description |
|---------|-------------|
| **Name** | Descriptive sentence about the setting. |

参考トピックのタイトル

参考トピックのタイトルは通常、名詞です。

以下のトピックタイトルは避けてください：

  • Important notes.その代わりに、この情報をあるべき場所に近づけてください。例えば、この情報はタスクの前提条件であったり、コンセプトに関する情報であったりします。
  • Limitations.その代わりに、他の類似した情報の近くにコンテンツを移動させましょう。どうしても必要なら、Known issues.