Skip to content

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

はじめに

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

はじめに(Get started)ページは、製品を使っていない新規ユーザーが、最短かつ正直な経路で最初の動作するセットアップまで到達できるようにします。トーンは手順を示しつつ、前向きにします。

使う場面

新規ユーザーが、製品を深く調べる前に、何もない状態から 1 つの動作する結果まで最短で進む必要があるときに、はじめにページを書きます。次のものではありません。

  • ハウツー。 ハウツーは、すでに製品を使っている読者向けに、特定の 1 タスクを完了させます。はじめにページは、新規ユーザーの最初の成功を最初から最後まで届けます。
  • チュートリアル。 チュートリアルは、より長いガイド付きプロジェクトで教えます。はじめにページは、最初の動作する結果で止まり、読者を次へ案内します。

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

タイトルと説明

  • タイトル: ページタイトルは「はじめに」です。
  • 説明: 製品名を挙げ、読者が完了する最初のセットアップを要約し、主な前提条件を記します。

このページのひな形

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

npx @cloudflare/nimbus-docs add content-quickstart

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

コンポーネントの指針

  • 前提条件 は、開始前に読者が必要なもの(アクティブなゾーン、サブスクリプションやプラン、Cloudflare 外のセットアップなど)を列挙します。
  • 手順 は、読者を製品の利用開始まで導きます。最小限のセットアップと、いちばん一般的なユースケースを扱い、ハウツーページのパーシャルを再利用することが多いです。
  • リンク は、動作するセットアップができたら、より深い設定へ進む次のステップでページを締めます。
  • 入れないもの: 網羅的な設定やエッジケース。それらはハウツーとリファレンスページに置き、リンクします。

Frontmatter

pcx_content_type: get-started
products:
  - product-a
  - product-b

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

AI とエージェント向けの執筆

  • 最短かつ正直な経路。 最初の動作する結果に届く手順だけを入れます。はじめにページは、網羅性ではなく、読者やエージェントがどれだけ早く成功に届くかで評価されます。
  • 結果を示す。 手順が生み出す動作する成果を述べ、示します。読者やエージェントは、次へ進む前に成功を確認できます。
  • 前提条件を揃える。 開始前に必要なものを正確に述べます。エージェントは、到達できる準備がなければセットアップを始められません。

役に立ちましたか?