所有新的 developers.cloudflare.com 产品都应包含下表列出的必需内容板块。其他板块可视用户成功使用产品所需的信息而定。
| 内容板块 | 是否必需? | 内容描述 |
|---|---|---|
概览 | 是 | 落地页的目的是欢迎用户并提供产品概览。 |
快速入门 | 是 | 快速入门内容的目的是帮助用户从未使用过某产品过渡到成功对其进行配置和设置。 |
如何操作 | 否 | 如何操作(how-to)文档的目的是说明如何完成产品内的某项任务。 |
概念 | 否 | 概念文档的目的是提供概念性或描述性信息,以便用户理解特定主题的背景和上下文。 |
参考 | 否 | 参考内容的目的是提供补充信息(“深度探索”),以便进一步了解设置、值或选项。虽然参考信息对用户很有帮助,但参考信息不应阻碍或阻止用户完成任务。 |
参考架构 | 否 | 参考架构的目的是提供高层级视图,展示 Cloudflare 平台的全貌或部分是如何构建的,以及 Cloudflare 产品如何融入客户现有的基础设施中。 |
教程 | 否 | 教程的目的是引导用户并将产品与真实世界场景联系起来。 |
解决方案指南 | 否 | 解决方案指南的目的是引导用户使用多个 Cloudflare 产品结合来实现特定目标,它从用户待完成的工作出发,而非从产品功能出发。 |
| API | 否 | API 内容列出了用户在成功发出其第一个请求之前必须完成的要求和任务。 |
故障排除 | 否 | 故障排除(Troubleshooting)内容的目的是为解决产品常见问题和边缘情况问题提供指导。 |
常见问题(FAQ) | 否 | 常见问题(FAQ)的目的是针对常见问题提供简明的解答。 |
第三方集成指南 | 否 | 第三方集成指南的目的是说明如何将第三方产品与 Cloudflare 配合使用。 |
更新日志 | 否 | 更新日志的目的是记录或记载显著的更改。 |
配置 | 否 | 配置文档的目的是展示特定设置、值和选项的示例。 |
导航 | 否 | 导航页面的目的是引导用户深入文档集,并作为文档特定区域的子落地页。 |