Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

コンセプト

最終更新 Markdown で表示Agent セットアップ

コンセプトページは、読者の頭の中にトピックのモデルを作ります。対象が何か、なぜその動きになるか、境界はどこかです。初めての導入にも、すでに製品を使っていて「なぜ」を補いたい読者にも向きます。トーンは説明的で、わかりやすく、寄り添うようにします。

使うタイミング

ほかのページの途中で、同じ説明が繰り返し必要になっているときにコンセプトページを書きます。その寄り道が、モデル専用の置き場が要る合図です。次のものではありません。

  • ハウツー。 コンセプトに手順や設定のウォークスルーは置きません。考え方を示すコードは歓迎します。読者がなぞって進めるコードは置きません。
  • リファレンス。 リファレンスは漏れがなく中立です。コンセプトは取捨選択があり、見解を持ちます。「推奨します」はここに置きます。
  • Overview。 Overview は先へ案内し、コンセプトは説明します。1 ページにつき 1 コンセプトにします。

全体の比較は コンテンツタイプ を参照してください。

タイトルと説明

  • タイトル: コンセプトを表す短い名詞句にします。製品の上位コンセプトページには「About」を使います。それ以外は、機能名や機能そのもの、Health checks や CDN のような Internet の概念を使います。「Overview」「Introduction」「How it works」は使いません。ジャンル名であり、対象名ではないためです。確認として、「About」を前に付けても自然に読めるタイトルがよいタイトルです。
  • 説明: コンセプトが何かと、読者のコードや選択にどう関わるかを述べます。

このページのひな形

Nimbus の concept レシピを使って、このページを生成します。コーディングエージェントがページのひな形と自己レビュー用チェックリストを取得し、製品に合わせて調整します。

npx @cloudflare/nimbus-docs add content-concept

レシピが出力する frontmatter を Cloudflare のスキーマに合わせて調整します。レシピが出力する type などの汎用フィールドではなく、pcx_content_typeproducts を設定します。

コンポーネントの指針

  • 本文が中心のコンポーネントです。 短い段落、1 セクションにつき 1 つの考え。このタイプは、文章の質がページを支えます。
  • 図と例示コード は、モデルを示すときに使います。図には必ず同等のテキストを添えます。
  • 比較テーブル は、本当に二者択一があるとき、混同しやすい境界と並べて使います。
  • 向かないもの: Steps(コンセプトに手順やウォークスルーはありません)、Tabs(コンセプトはプラットフォームで分かれません。分かれるなら 2 つのコンセプトです)、Cards。

frontmatter

pcx_content_type: concept
products:
  - product-a
  - product-b

詳細は pcx_content_type を参照してください。

AI とエージェント向けの書き方

  • 自己完結した定義。 「少なくとも 1 回」や「順序は保証しない」のように、確認できる契約から書き始めます。安心させる形容詞は使いません。エージェントが取得して引用するのは定義の段落なので、単独で成立する必要があります。
  • リテラルなペイロード。 例示コードとペイロードは、言い換えではなく、完全で現実的な値のフェンス付きブロックに置きます。
  • 宣言的な境界。 コンセプトが何でないかを、平坦な宣言の箇条書きで書きます。エージェントが本文を再構成せずに抜き出せるようにします。

役に立ちましたか?