概念コンテンツは、ユーザーが機能またはトピックを理解するのに役立ち、明確な概要、機能またはトピックが自分の体験にどのように役立つかの説明、ユース ケースや例などのコンテキストが提供されます。
その他の記事内では概念記事と概念セクションを作成します。 ほとんどの主な製品、機能、または件名には、独自の概念に関する記事があります。
概念コンテンツを記述する方法
概念コンテンツ テンプレートについては、「テンプレート」を参照してください。
- 機能、製品、またはトピックとは何かをわかりやすい言葉で説明します。
- その目的と、閲覧者にとって便利な理由について説明します。
- ユース ケースまたは例を共有します。
- 関連する場合は、機能またはトピックのしくみを説明します (対象ユーザーと技術的な詳細を調べるのに適した場所に留意してください)。
- 機能を使用するために閲覧者が知っておく必要がある詳細をすべて強調表示します。
- 機能の使用を開始するための次の手順を含めます (参考資料のリンクと記事自体内のコンテンツのいずれを使用するかにかかわらず)。
概念コンテンツのタイトル
- 概念記事または概念セクションのヘッダーは、「[件名] について」で始まります。
- 名詞を使用して件名を記述します。
- 使用する: 「code scanning について」
- 避ける: 「コードの脆弱性のスキャンについて」
概念コンテンツの例
- 概念に関する記事
- 他の記事の概念セクション
- 「リポジトリへのセキュリティ ポリシーの追加」の「セキュリティ ポリシーについて」
- 「メンテナンスモードの有効化とスケジューリング」の「メンテナンス モードについて」