Overview は、製品領域で読者が最初に到達するランディングページです。1 段落で「これは何か、どこから始めるか」に答え、その先へ案内します。トーンはわかりやすく、歓迎的で、会話調で、率直にします。
製品または主要な製品領域の、唯一のランディングページとして Overview を使います。サイドバーのそのセクションを開いたときに表示されるページです。次のようなページではありません。
- コンセプトページではありません。 アーキテクチャやトレードオフはコンセプトページへ移し、そこへリンクします。Overview は説明ではなく、道案内です。
- 目次だけではありません。 道案内のないリンク一覧は、サイドバーの重複になります。
- マーケティングページではありません。 読者はすでにドキュメントへ入っています。
全体の比較は コンテンツタイプ を参照してください。公開中の例は Argo Smart Routing の Overview を参照してください。
- タイトル: 製品、製品グループ、またはコンテンツ領域の名前を、名詞で書きます。「documentation」を付けたり、動名詞の句にしたり、「Introduction」を使ったりしません。
- 説明: Cloudflare の製品名と、誰に何をするかを 1 文で述べ、利用できるプランを示します。
Nimbus の overview レシピを使って、このページを生成します。コーディングエージェントがページのひな形と自己レビュー用チェックリストを取得し、製品に合わせて調整します。
npx @cloudflare/nimbus-docs add content-overviewyarn @cloudflare/nimbus-docs add content-overviewpnpm @cloudflare/nimbus-docs add content-overviewレシピが出力する frontmatter を Cloudflare のスキーマに合わせて調整します。レシピが出力する type などの汎用フィールドではなく、pcx_content_type と products を設定します。
- Cards が中心のコンポーネントです。案内そのものが本文になるため、カードを本文にするのはこのタイプだけです。カードの文言は名前と 1 行にとどめます。説明してしまうカードは、箱に入ったコンセプトの段落です。Markdown 版では、カードはリンクと説明のリストに平坦化されます。どちらの形でも通じる 1 行を書いてください。
- リンクリストは、グリッドだと文言を水増しせざるをえない場合や、グループがおおよそ 5 リンクの上限を本当に超える場合に、カードより適します。件数が多いときは、散文のリストのほうが眺めやすいです。
- 使わないもの: Steps（ここでは何も実行しません）、コードブロック（参照するものはありません。道案内の 1 行にインラインコードを書くのは問題ありません）、アコーディオン（隠したコンテンツがある Overview は、地図そのものを隠しています）。
pcx_content_type: overview
products:
- product-a
- product-b
- product-c詳細は pcx_content_type を参照してください。
製品または主要な製品領域には、必ず Overview が必要です。弱いページへの対処は、必ず強化であり、削除ではありません。目次だけのように読める場合は、その領域が何か、どこから始めるかを示す道案内を足します。削除してサイドバーに任せないでください。
非表示にするのは、構造上のグループノードだけです。子ページをサイドバーでまとめるためだけに存在するフォルダーで、もともとコンテンツページではなかったものです。フォルダーの index.mdx を削除するとビルドエラーになるため、プレースホルダーを隠し、group.hideIndex を true にして読者を先へリダイレクトします。
---
title: Placeholder
sidebar:
group:
hideIndex: true
---- 自己完結した道案内。 冒頭の段落は、単独でも正確であるように書きます。製品が何かと聞かれたときに、エージェントが引用するのはこの段落です。意味をタイトルや後のセクションに依存させないでください。
- 利用可否は字義どおりに。 言い換えではなく、プラン、リージョン、リリース段階の正式名称で利用可否を述べます。
- リンクは実在する経路を使う。 現行の正しいルートを使います。古いルートは、入口で読者を迷わせます。