Cloudflare Docs
Style Guide
Cloudflare Docs
Style Guide
GitHub icon
Edit this page on GitHub
Set theme to dark (⇧+D)
  1. Products
  2. Style Guide
  3. Developer documentation content strategy
  4. Information architecture

Information architecture

The information architecture (IA) of the Cloudflare developer documentation follows a consistent pattern. Product documentation always includes an Overview and Get started page. Including other content types depends on the product, how it is used, and what content users need to be successful.

​​ Developer Platform information architecture

At launch, Cloudflare Developer Platform products are recommended to include the following high-level sections. The following is a recommended guideline based on standard user journey flow (Learn, Get started, Configure, Test, Deploy, Asses, Maintain, etc.) and is intended to serve as a helpful reference to the documentation writer and collaborators. Depending on the product and as products mature, the IA may grow out of this structure or differ from this structure based on what you can do with the product. For an example of a more mature product that differs from this IA, refer to the Cloudflare Stream documentation.

  • Overview
  • Get started
  • Configuration - Steps that come after getting started, including features (like Cron Triggers and Smart Placement for Workers) or the delta between getting started and your desired state. As a product matures, content in Configuration might expand into its own top-level sections.
  • Observability - Information about testing, metrics, analytics, local development, etc. Alternative title: Testing & Observability.
  • Reference
  • Concepts
  • Platform - Section unique to Developer Platform products that includes Pricing, Limits, Storage options, Changelog, Betas, and Known issues pages.