コンセプト・トピック・タイプ

コンセプトは、1つの機能や概念を紹介するものです。

コンセプトは質問に答えるものでなければなりません：

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

このコンセプトを聞いたことがない人が知りたいことをすべて考えてください。

どうすればこのことができるかを教えるのではありません。それが何であるかを伝えましょう。

別のコンセプトについて説明し始めたら、新しいコンセプトを立ち上げ、それにリンクさせましょう。

コンセプトはこのような形式にしてください：

# Title (a noun, like "Widgets")

A paragraph or two that explains what this thing is and why you would use it.

If you start to describe another concept, stop yourself.
Each concept should be about **one concept only**.

If you start to describe **how to use the thing**, stop yourself.
Task topics explain how to use something, not concept topics.

Do not include links to related tasks. The navigation provides links to tasks.

コンセプトのトピックタイトル

タイトルテキストには名詞を使用します。例えば

  • Widgets
  • GDK dependency management

より説明的な単語が必要な場合は、ing ではなく、ion バージョンの単語を使用します：

  • Object migration の代わりに、Migrating objects またはMigrate objects

ing で終わる単語は翻訳しづらく、スペースを取ります。また、タスクトピックには能動態動詞を使用します。詳しくはGoogleスタイルガイドをご覧ください。

避けるべきタイトル

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

  • Overview またはIntroduction 。代わりに、誰かが検索するような、より具体的な名詞やフレーズを使用します。
  • Use cases.代わりに、情報をコンセプトの一部として組み込んでください。
  • How it works.代わりに、名詞の後にworkflow をつけます。例えば、Merge request workflow。