用語集トピックタイプ

用語集は、ユーザーが特定のGitLab機能を理解するのを助けるために、馴染みのない用語とその定義のリストを提供します。

それぞれの用語集は、一つの用語とそれに関連する定義を提供します。定義は質問に答えるものでなければなりません：

  • これは何ですか？
  • なぜ使うのですか？

用語集に

  • 専門用語は使用しないでください。
  • 内部用語や略語を使用しないでください。
  • 単語リストに正しい用法が定義されていることを確認してください。

用語集に代わるもの

用語集は、短く簡潔な用語と用語の対を提供する必要があります。

  • 簡単な説明以上の定義が必要な場合は、代わりに概念トピックを使用してください。
  • 機能の使い方を説明する必要がある場合は、代わりにタスクトピックを使用してください。

用語集の例

用語集のトピックはこのような形式にしてください。主に順序なしのリストを使用します。さらに分類が必要な場合は、表を使用することもできます。

用語集のトピックは、独立したページとしてではなく、その機能を説明するページに含めるようにしてください。

## FeatureName glossary

This glossary provides definitions for terms related to FeatureName.

- **Term A**: Term A does this thing.
- **Term B**: Term B does this thing.
- **Term C**: Term C does this thing.

表形式を使用する場合

## FeatureName glossary

This glossary provides definitions for terms related to FeatureName.

| Term   | Definition              | Additional category |
|--------|-------------------------|---------------------|
| Term A | Term A does this thing. |                     |
| Term B | Term B does this thing. |                     |
| Term C | Term C does this thing. |                     |

用語集のトピックタイトル

FeatureName glossaryを使用してください。

glossaryの代替は使わないでください。例えば

  • Terminology
  • Glossary of terms
  • Glossary of common terms
  • Definitions