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

快速入门

最后更新 查看 MarkdownAgent 设置

快速入门页面以最短且诚实的路径,带领新用户从未使用某产品到达第一次可用设置。语气为指导性、鼓励性。

何时使用

当新用户需要在深入探索产品之前,从零到达一个可用结果的最短路径时,请编写快速入门页面。它不是:

  • 如何操作。 如何操作为已经在使用产品的读者完成一项特定任务,而快速入门页面端到端交付新用户的第一次成功。
  • 教程。 教程通过更长的引导式项目教学,而快速入门页面在第一次可用结果处停止,并将读者导向后续内容。

完整比较请参阅内容类型。

标题与描述

  • 标题:页面标题为 Get started。
  • 描述:点出产品,概括读者完成的第一次设置,并注明关键先决条件。

搭建此页面

使用 Nimbus get-started 模板生成此页面。你的编程代理会获取完整页面框架和自查清单,然后根据你的产品进行调整:

npx @cloudflare/nimbus-docs add content-quickstart

将模板生成的 frontmatter 调整为 Cloudflare 的 schema:设置 pcx_content_type 和 products,替代模板生成的 type 等通用字段。

组件指引

  • 先决条件列出读者开始前需要具备的条件,例如活跃的 zone、订阅或计划,或 Cloudflare 之外的设置。
  • 步骤引导读者到达产品采用,覆盖最低限度设置加上最通用的用例,并经常复用如何操作页面中的 partials。
  • 链接在页面结尾给出后续步骤,在读者已有可用设置后指向更深入的配置。
  • 不适合放入的内容: 穷尽配置或边缘情况。把它们放在如何操作和参考页面中,并给出链接。

Frontmatter

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

欲了解更多详情,请参考 pcx_content_type。

示例

面向 AI 和智能体编写

  • 最短且诚实的路径。 只包含到达第一次可用结果所需的步骤,因为快速入门页面的评判标准是读者或智能体多快获得成功,而不是覆盖面。
  • 展示结果。 说明并展示这些步骤产生的可用结果,以便读者或智能体在继续之前验证成功。
  • 写全先决条件。 准确说明读者开始前需要具备的条件,因为智能体无法开始它尚未准备好进入的设置。

这篇文档对您有帮助吗?