页面开篇位于顶部,告诉读者本页涵盖什么、面向谁,以及是否值得继续阅读。本页涵盖三部分:上下文、介绍和目标受众。
紧跟页面标题之后的引导段落,说明读者可以从内容中期待什么,无论是步骤、概念、FAQ 还是参考材料。
结构因内容类型而异:
- 如何操作:关于步骤及其将完成事项的引导段落。提供章节标题中没有的上下文。如果紧接步骤,以冒号结尾;如果上下文与程序之间还有注释等内容,以句号结尾。不要使用由编号步骤来补全的残缺句子。
- 配置:标题后紧跟的段落,介绍该功能、说明读者将遇到的配置,并链接到其他相关文档。
- FAQ:关于该章节以及读者可以从中期待什么的引导段落。
- 概念:简要说明读者为什么应该关注这些信息。
- 参考:关于读者如何以及为何可能使用页面信息的引导段落。
- 教程:关于读者目标以及他们将如何在教程中达成该目标的引导段落。可考虑包含目标受众。
对内容将涵盖内容的概述,用于篇幅较长的文档,帮助读者判断是否值得投入时间阅读。
不超过半页,通常一到三段。第一段应快速、清晰地说明主题,最后一段应说明文档包含什么。
例如:
Cloudflare One 是一个安全访问服务边缘(SASE)平台,用于保护企业应用程序、用户、设备和网络。通过逐步采用 Cloudflare One,组织可以摆脱由硬件设备和各类点状方案拼凑而成的体系,转而将安全和网络能力整合到一个统一的控制平面上。这种网络与安全转型有助于应对现代企业面临的关键挑战,包括:
- 以 Zero Trust 实践确保任何用户对任何资源的访问安全
- 防御网络威胁,包括多渠道网络钓鱼和勒索软件攻击
- 保护数据以符合法规并防止泄露
- 简化办公室、数据中心和云环境之间的连接
Cloudflare One 构建于 Cloudflare 的连接云之上。这是一个统一、智能的可编程云原生服务平台,可在所有网络(企业网络和互联网)、云环境、应用程序和用户之间实现任意到任意的连接。它是规模最大的全球网络之一,数据中心遍布全球数百个城市,并与 over 13,000 network peers 互联。
本文档描述面向正在迈向 SASE 架构的组织的参考架构,并说明 Cloudflare One 如何促成这种安全与网络转型。
概括内容面向谁,以及读者将学到什么。与上下文或介绍结合,可让读者理解页面主题以及内容是否与其职责相关。
以副标题 Who is this for? 开头,篇幅控制在一到三段。第一段应描述文档的目标读者类型。如果文档依赖已有知识,请链接三到五个读者可以先阅读的资源。最后一段应包含两到三个具体要点,说明读者将学到什么。
例如:
Who is this for?
本参考架构面向对其组织现有基础设施负有一定责任或较为熟悉的 IT 或安全专业人员。具备保护混合办公所需技术的一些经验会很有帮助,包括身份提供商(IdP)、用户目录、单点登录(SSO)、端点安全或管理、防火墙、路由器以及各类点状方案。
为了更扎实地理解 Cloudflare,我们建议阅读以下资源:
- What is Cloudflare? | 网站(约 5 分钟阅读)或视频(约 2 分钟)
- Solution Brief: Cloudflare One(约 3 分钟阅读)
- Whitepaper: Reference Architecture for Internet-Native Transformation(约 10 分钟阅读)
- Blog: Zero Trust, SASE, and SSE: foundational concepts for your next-generation network(约 14 分钟阅读)
阅读本参考架构的人将了解:
- Cloudflare One 如何保护组织的员工、设备、应用程序、数据和网络
- Cloudflare One 如何融入现有基础设施,以及如何着手迁移到 SASE 架构
- 如何规划部署 Cloudflare One