跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

内容类型

最后更新 查看 MarkdownAgent 设置

每个文档页面都有一种内容类型:对其包含什么、如何组织以及如何维护的既定形态。选对类型,页面就能对读者和智能体保持可预期。每个新产品都需要概览和快速入门页面,其他类型则取决于读者需要什么。

本页按内容所承担的工作对类型分组,方便您区分容易混淆的几种。任一类型的完整指南,请参阅各表中的对应页面。

任务与设置内容

读者要完成某件事时使用的类型。

内容类型 在以下情况选择它
如何操作 读者已经选定产品,需要在其中完成一项具体任务。
教程 读者通过端到端构建真实项目来学习,过程与结果同样重要。
快速入门 新用户需要从零到第一个可用结果的最短路径。
第三方集成指南 读者要将某个特定外部产品与 Cloudflare 连接,并且您承诺维护该指南。
配置 某功能配置密集,读者主要需要设置和取值,而不是步骤。

解释与查阅内容

读者要理解或查找某事时使用的类型。

内容类型 在以下情况选择它
概念 读者需要理解某事物是什么,以及它为何这样运作。
参考 读者需要查阅完整、中立的细节,例如每一个参数、取值或选项。
概览 新读者需要在一段文字中了解产品区域,然后再被引导到后续内容。
常见问题(FAQ) 常见问题各自应有简短、直接的答案,并链接到事实来源。
故障排除 读者遇到了具体错误或症状,需要原因和修复方法。

架构与规划内容

用于设计解决方案而非实施解决方案的类型。

内容类型 在以下情况选择它
参考架构 您在设计层面展示多个产品如何适配客户环境中的各类用例。
设计指南 读者在动手之前规划某一具体解决方案及其背后的架构决策。

路标与记录内容

用于引导读者继续前进,或记录变更的类型。

内容类型 在以下情况选择它
导航 某个区域的子页面足够多,读者需要一个带路标的入口进入这些页面。
更新日志 您记录产品中带日期的显著变更。

这篇文档对您有帮助吗?