参考架构是高层级设计文档,展示 Cloudflare 产品如何融入客户现有基础设施,并将其用例映射到 Cloudflare 解决方案。语气为指导性、直截了当。
本页说明如何编写参考架构。已发布的架构本身,请参阅参考架构。
当您需要在设计层面展示多个 Cloudflare 产品如何组合,以适配客户环境及用例时,编写参考架构。这类文档通常很详细。它不是:
- 概念。 概念深入解释一个想法;参考架构展示多个产品如何在真实环境中协同。
- 如何操作。 参考架构描述并设计,而不是给出操作步骤。
若单个架构几乎不需要文字说明,请改用参考架构图。完整对比请参阅内容类型。实例如 Cloudflare Load Balancing 参考架构、Magic Transit 参考架构,以及使用 Cloudflare 演进到 SASE 架构。
- 标题:命名该架构或解决方案的名词短语,例如 “Cloudflare Load Balancing Reference Architecture”。
- 描述:点明解决方案和产品,说明它们如何适配现有基础设施以及针对哪些用例,并写明目标受众,例如 IT 和安全专业人员。
复制此骨架并根据您的架构进行调整:
---
title: <Noun phrase naming the architecture or solution>
description: How <products> fit <infrastructure> for <use case>, written for <the intended audience>.
pcx_content_type: reference-architecture
sidebar:
order: 10
products:
- product-a
---
Open with two or three paragraphs on the subject matter, then state who the document is for and what they will learn.
## <Architecture area>
Present the reference diagram with numbered callouts, and explain each element in prose so the meaning survives without the image.
## <Use case to solution>
Map the customer use case to the Cloudflare solution, and flag any caveats that affect how the architecture applies.
## Related links
Link the supporting how-tos, concepts, and product documentation with current routes.- 图表 是标志性组件:单张参考图反映整体架构,用图注和编号标注解释每个元素,并用补充图表展开具体部分。
- 介绍与目标受众 用正文打开文档,先用两到三段说明主题,再说明写给谁、他们将学到什么。
- 注释和警告 标出影响该架构如何适用的注意事项。
- PublicStats 在能加强架构论证时展示 Cloudflare 网络统计。
- 不适合放在这里的内容: 操作步骤,因为参考架构是设计而非指导。实施请链接如何操作文档。
pcx_content_type: reference-architecture
products:
- product-a
- product-b有关更多详细信息,请参阅 pcx_content_type。
参考架构图是更轻量的变体:一张带编号标注的图,配上刚好够解释它的文字,适用于不需要完整书面架构的解决方案。语气为指导性、直截了当。
- 何时使用:当一张图就能承载解决方案、几乎不需要文字说明时使用。若设计需要详细讨论,请选择完整参考架构。
- 标题:与完整参考架构一样,使用名词短语。
- 结构:单张参考图、解释每个元素的编号标注、该图所关联内容的简短描述,以及指向配套内容的相关链接。
- Frontmatter:将
pcx_content_type设为reference-architecture-diagram。
- 每张图都要有文本等价物。 用正文解释每个编号标注,并为图提供文本等价物,因为智能体无法阅读图像,含义必须在没有图像时仍然成立。
- 字面的产品名与用例名。 在正文中写出确切的 Cloudflare 产品和用例,而不是只写在图里,这样架构本身即可被检索到。
- 承重链接。 用真实、现行的路由链接配套的如何操作、概念和产品文档,因为架构要向外指向实施内容。