Configuration ページは、設定の多い機能の具体的な設定項目、値、オプションを示します。手順を追うのではなく、用途に合った構成をコピーできるようにします。ユースケースとも呼びます。Configuration は手順ではなく、参照用のページです。トーンは平易で、説明的で、率直にします。
ルールなど、設定の多い機能で、読者が主に「どの設定と値で、どの結果になるか」を知る必要があるときに Configuration を書きます。次のものではありません。
- how-to ではありません。 how-to は作業を完了する手順を案内します。Configuration は構成の設定と値だけを示し、手順は書きません。
- チュートリアルではありません。 チュートリアルは案内付きのプロジェクトで教えます。Configuration は正しい値を調べるリファレンスであり、講座ではありません。
- リファレンスではありません。 リファレンスはすべてのパラメーターを漏れなく記録します。Configuration はよくある用途向けの構成例を選びます。
全体の比較は コンテンツタイプ を参照してください。
- タイトル: 設定する機能名を名詞で書きます。Configuration は目標へ導くのではなく、機能の設定方法を示すためです。
- 説明: 設定する製品または機能、対象の用途、扱う主要な設定や値を書きます。
このスケルトンをコピーし、機能に合わせて調整します。
---
title: <Feature> configuration
description: Configure <product or feature> for <use case>, covering <the key settings and values>.
pcx_content_type: configuration
sidebar:
order: 10
products:
- product-a
---
Introduce the feature in two or three sentences, frame which configurations the reader will encounter, and link to related documentation.
## <Feature area>
State the outcome this configuration produces, then give the settings and values in a table.
| Setting | Value | Notes |
| -------------- | -------------------------- | ---------------- |
| <setting name> | <value to enter or select> | <when to use it> |- 表 が中心です。読者が変えられる各設定と、ある用途で入力または選択する値を 1 対 1 で対応させたリファレンステーブルにします。
- Navigation は、機能に Configuration が多数あるときに、適切な構成へ案内します。
- 向かないもの: 手順です。手順を書いてしまいそうなら、how-to、チュートリアル、または example を使います。
pcx_content_type: configuration
products:
- product-a
- product-b詳しくは pcx_content_type を参照してください。
各 Configuration は、タイトルの直後に短い文脈の段落を置きます。機能を紹介し、読者が出会う構成の範囲を示し、関連ドキュメントへリンクします。本文は機能ごとにまとめ、機能ごとに設定テーブルを置きます。読者が自分の用途に合う構成へスキャンできるようにします。
- 設定と値の組を完結させます。 各行に明示的な設定と、入力または選択する正確な値を書きます。エージェントが推測せず、その組をそのまま適用できるようにします。
- 用途で枠を示します。 各構成が生み出す結果を文脈で述べます。読者やエージェントが手順を読まずに、目標と正しいテーブルを照合できるようにします。
- 手順は外へ出します。 手順がある場合は、それを扱う how-to、チュートリアル、example へリンクします。Configuration 自体は手順として実行できるものではありません。