トピックは記事をフィルター処理するために使用され、GitHub Docs サイトで検索できます。 ランディング ページやガイドなどの一部のレイアウトでは、ユーザーはトピックをフィルター処理して表示する記事を選択できます。 これらのガイドラインを使用すると、記事の frontmatter に追加するトピックを選択するのに役立ちます。 トピックへの記事の追加について詳しくは、「トピック」、許可されているすべてのトピックのリストについては、allowed-topics に関するページを参照してください。
すべてのコンテンツの種類のトピック
- すべての記事に少なくとも 1 つのトピックが必要です
- 名詞をトピックとして使用します
- トピックは、ユーザーがコンテンツを有意義にグループ化するのに役立ちます
- 可能な場合は、単に広範なトピックではなく、関連するより具体的なトピックを使用します。 たとえば、単に
APIではなくRESTやGraphQLとします - トピックでフィルター処理を行うユーザーがすべての関連記事を取得できるように、同様の記事のトピックが一貫していることを確かめます。 たとえば、CI に関するすべての記事には、
CIトピックとより具体的なトピックが含まれている必要があります - あいまいなトピックは避けます。 たとえば、製品の GitHub Actions やアクションという製品要素が参照される場合があるため、
Actionsは Actions 製品内では有用なトピックではない可能性があります
- 可能な場合は、単に広範なトピックではなく、関連するより具体的なトピックを使用します。 たとえば、単に
- トピックは価値を付加するためのものであり、記事のタイトル、種類、カテゴリはレプリケートされません
- たとえば、Actions 製品内では、
Actionsドキュメントのこのセクションのユーザーが Actions ドキュメントを参照していることを既に認識しているため、価値は付加されません
- たとえば、Actions 製品内では、
- 製品領域の主要な概念に関連する記事には
Fundamentalsを使用します。- 使用する: 「GitHub Actions の概要」のような記事では
Fundamentals - 避ける: 「GitHub Actions の概要」のような記事では
Actions
- 使用する: 「GitHub Actions の概要」のような記事では
- 一般的に認識される省略形を使用できますが、あいまいな省略形は避ける必要があります
- 使用する:
Continuous integrationではなくCI - 避ける:
Advanced SecurityではなくAS
- 使用する:
- GitHub 製品名の短い形式を使用します
- 使用する:
GitHub ActionsではなくActions
- 使用する:
トピックを選ぶためのチェックリスト
記事のトピックを選ぶのに役立つこれらの質問を検討してください。 すべての記事にチェックリストの各項目のトピックがあるわけではありません。
- 機能または製品領域は何ですか?
- 例:
Enterpriseサブ機能に関する記事ですか (製品名が機能名と一致する場合を除く)? - 例:
Dependabot
- 例:
- 制限付きプログラムの機能部分ですか?
- 例:
Advanced Security
- 例:
- 記事の機能または製品の要素は何ですか?
- 例:
Organizations
- 例:
- 記事の広範な目的は何ですか?
- 例:
Permissions
- 例:
- 記事では、どのようなプログラミング言語、パッケージ マネージャー、またはエコシステムに明示的に対応していますか? サポートされている言語、パッケージ マネージャー、またはエコシステムが記事に一覧表示されている場合だけでなく、ドキュメントをフィルター処理するユーザーに価値を付加する場合にのみ、これらのトピックを含めます。
- 例:
Ruby
- 例: