设计指南帮助读者使用 Cloudflare 规划并设计特定解决方案,重点放在配置之前的架构决策。设计指南是参考架构的聚焦子集。语气为指导性、直截了当。
当读者需要规划某一特定解决方案的架构,并在动手构建前理解决策与权衡时,请编写设计指南。它不是:
- 参考架构。 参考架构描述跨越多个产品的宽泛架构,而设计指南收窄到其中某一特定解决方案的规划。
- 如何操作。 如何操作给出配置产品的步骤,而设计指南在任何配置开始之前推理架构决策与权衡。
完整比较请参阅内容类型。
- 标题:第二人称命令式的短动词短语,不要使用动名词。优先使用 “Securely deliver applications with Cloudflare”,而不是 “Securely delivering applications”。
- 描述:点出读者将规划并设计的解决方案、涉及的 Cloudflare 产品,以及涵盖的架构决策。
复制此骨架并按你的解决方案进行改写:
---
title: <Verb phrase naming the solution to plan>
description: Plan and design <solution> with <Cloudflare products>, covering <the architecture decisions>.
pcx_content_type: design-guide
sidebar:
order: 10
products:
- product-a
---
用两到三段开篇,描述主题以及该解决方案的最终状态。
## Intended audience
概括指南面向谁,以及他们将学到什么。
## <Architecture decision or design area>
描述设计及其背后的决策与权衡,包含架构图,并外链到实现它的如何操作和教程。
## Related links
指向该设计所依据的参考架构和产品文档。- 介绍用两到三段开篇,描述主题以及本指南所详述解决方案的最终状态。
- 目标受众概括指南面向谁,以及他们将学到什么。
- 图表展示架构,这是设计指南的核心。
- 注释和警告标出影响设计适用方式的注意事项和权衡。
- 相关链接指向该设计所依据的参考架构和产品文档。
- 不适合放入的内容: 分步配置程序。设计指南规划解决方案,因此应外链到实现它的如何操作和教程。
pcx_content_type: design-guide
products:
- product-a
- product-b欲了解更多详情,请参考 pcx_content_type。
- 写设计,不写步骤。 描述架构及其背后的决策,并外链到实现它们的如何操作和教程,因为设计指南是智能体据此推理的计划,而不是它要运行的程序。
- 说明最终状态。 开篇就描述指南产出的完成态解决方案,以便读者或智能体在跟随设计前知道目标。
- 点明受众和假设。 说明指南面向谁以及它所假设的基础设施,因为设计指南只对具备正确上下文的读者可执行。