概念コンテンツは、ユーザーが機能またはトピックを理解するのに役立ち、明確な概要、機能またはトピックが自分の体験にどのように役立つかの説明、ユース ケースや例などのコンテキストが提供されます。
他の記事内に概念に関する記事と概念セクションを作成します。 ほとんどの主要な製品、機能、または主題には、独自の概念に関する記事があります。
記事またはセクションを決定する
ハウツーやチュートリアルでは、手順の前に 1 ~ 2 個の簡単な入門文を含めることができます。 2〜3文を超える説明が必要な場合は、その内容を概念記事で扱うべきかどうかを検討する必要があります。
ただし、選択する必要があります。 すべての概念または "About X" セクションに独自の記事が必要なわけではありません。 通常、これは、含める必要があるユーザーにとって役に立つ情報の量にかかっています。
概念コンテンツを記述する方法
概念コンテンツ テンプレートについては、「テンプレート」をご覧ください。
- 機能、製品、またはトピックとは何かをわかりやすい言葉で説明します。
- その目的と、閲覧者にとって便利な理由について説明します。
- ユース ケースまたは例を共有します。
概念コンテンツのタイトル
記事の短いタイトルは、1 つの単語または名詞句にする必要があります。 サイドバーの [概念] の下に記事が表示される場合は、同じ名前の見出しの下に記事が表示されない限り、"About" を使用しないでください。 例: "コーディング エージェント" と "コーディング エージェントについて"
記事の概念セクションのヘッダーは、"About [subject]" で始まります。
- 名詞を使用して件名を記述します。
- 使用: " code scanningについて"
- 避けましょう: 「コードの脆弱性をスキャンすることについて」
概念コンテンツの例
- 概念に関する記事
- 他の記事の概念セクション
- 「リポジトリへのセキュリティ ポリシーの追加」の「セキュリティ ポリシーについて」
- 「メンテナンスモードの有効化とスケジューリング」の「メンテナンス モードについて」