コンテンツにスキップ

情報アーキテクチャ

Cloudflareの開発者ドキュメントの情報アーキテクチャ(IA)は、一貫したパターンに従っています。製品ドキュメントには常に概要始めるページが含まれます。他のコンテンツタイプを含めるかどうかは、製品、使用方法、およびユーザーが成功するために必要なコンテンツによって異なります。

開発者プラットフォームの情報アーキテクチャ

Cloudflare Developer Platform製品の立ち上げ時には、以下の高レベルのセクションを含めることが推奨されます。以下は、標準的なユーザージャーニーフロー(学ぶ、始める、設定する、テストする、デプロイする、評価する、維持するなど)に基づいた推奨ガイドラインであり、ドキュメント作成者やコラボレーターにとって役立つ参考として意図されています。製品によっては、また製品が成熟するにつれて、IAはこの構造から外れることや異なる構造になることがあります。このIAと異なるより成熟した製品の例については、Cloudflare Streamドキュメントを参照してください。

  • 概要
  • 始める
  • 設定 - 始めた後のステップで、機能(CronトリガーやWorkersのスマート配置など)や、始めることと希望する状態との間の差分を含みます。製品が成熟するにつれて、設定のコンテンツは独自のトップレベルセクションに拡張される可能性があります。
  • 可観測性 - テスト、メトリクス、分析、ローカル開発などに関する情報。代替タイトル: テストと可観測性
  • リファレンス
  • 概念
  • プラットフォーム - 価格、制限、ストレージオプション、変更履歴、ベータ版、既知の問題ページを含む、開発者プラットフォーム製品に特有のセクション。