参照コンテンツ タイプ

参照コンテンツは、ユーザーが機能をアクティブに使用している間に必要な詳細情報を提供します。

この記事で

参照コンテンツは、特定の情報について参照されます。 これは、すばやく確認できる情報です。つまり、文や段落に重点が置かれることはありません。

参照には、テーブル、リスト、またはその他の構造化形式で最適に表現できる情報が含まれます。 参照は、自動生成されたパイプライン コンテンツや、自動化される可能性があるその他のコンテンツを含めると考えられる場合があります。

参照コンテンツは、他の記事内の参照記事と参照セクションに表示されます。

  • 一部の主要な主題では、特に検索構文や GitHub Actions の YAML 構文など、大量の参照コンテンツがある場合は、独自の参照記事が必要になる場合があります。
  • 機能でサポートされている言語やハードウェア要件の一覧など、コンテンツの量が少ない場合、またはより具体的な情報を得る場合は、手続き型または概念的な記事内のコンテキストで参照セクションを使用します。

参照コンテンツを記述する方法

参照コンテンツ テンプレートについては、 テンプレート を参照してください。

  • 参照コンテンツを紹介する文または概念セクション全体を記述します。
  • 実際の参照コンテンツを明確かつ一貫して提示します。
  • 説明する要素が 1 つの件名の場合は、リストを使用します。
  • 説明する要素が複数ある件名の場合は、テーブルを使用します。
  • ワークフローの YAML 構文など、より長い参照コンテンツの場合は、ヘッダーを一貫して使用します。

参照コンテンツのタイトル

  • 参照記事または参照セクションのヘッダーは、セクションのコンテンツを明確に記述するものであり、一般に名詞で始まります。
  • タイトルには、初心者ユーザーがアクセスできる十分な情報が含まれており、各セクションのコンテンツが完全に記述されます。
  • タイトルに複数の名詞を並べないでください。前置詞を使用して、名詞の長い文字列を分割します。
  • 短いタイトルは、1 つの単語または短い名詞句にする必要があります。 例: "AI モデル"。

参照コンテンツの例