图像帮助读者看见工具、流程或架构。本页涵盖三类:屏幕截图、图表和参考架构图。图像的维护成本高于文本,因此要有意识地使用。
屏幕截图是软件工具的画面,在本文档中通常是 Cloudflare 仪表板。我们只建议在特定场景使用屏幕截图,因为它们的维护成本高于其他内容类型。
请有节制、有目的地使用屏幕截图。例如,当任务本身简单,但经常让读者困惑,或仅用文字难以描述时,适合使用屏幕截图。
一个典型例子是查找账户和 zone ID,原因如下:
- 它会大量把 SEO 流量导向我们的 Community ↗。
- 我们曾尝试只用文字解释,但未能消除困惑。
- 这项任务尤其面向新用户,他们对 Cloudflare 概念或导航模式还不熟悉。
屏幕截图应当:
- 保持原始纵横比锁定。
- 分辨率保持 72dpi。
- 宽度保持 500-600 像素。
- 避免分享敏感信息(可能需要在浏览器中编辑底层 HTML)。
- 避免包含频繁变化的界面元素,例如侧边栏导航。
- 提供描述性替代文本(alt text)。
将屏幕截图添加到 /src/assets/images/ ↗ 下对应的 $PRODUCT_NAME 文件夹。出于组织需要,也可以添加子文件夹。
没有明确用途的屏幕截图我们会避免使用,因为它们难以维护。原因包括:
- 界面可能变化,而我们的团队不一定知情。
- 即使你知道发生了什么变化,也很难找出哪些屏幕截图引用了特定的界面流程。
- 一旦有变化,你需要重新完整截图来替换。这可能涉及添加假数据或隐藏敏感信息。
我们如何处理这类维护,请参阅图像维护。
图表是描绘流程、架构或其他技术形态的可视化。它们以更有说服力的方式解释复杂主题,并帮助读者想象特定解决方案、流程或产品之间的交互。各类内容类型都可以使用图表。我们建议使用 SVG 文件或 Mermaid 图表。
请使用 SVG 而不是 PNG 或 JPEG,因为读者放大时 SVG 可以良好缩放。为 SVG 提供清晰直白的替代文本,供屏幕阅读器使用。我们会用仓库中的定期脚本 ↗优化 SVG 文件。
按如下方式格式化 SVG:
例如:

使用 Mermaid 图表说明产品或流程。如果适合你的用例,Mermaid 图表优于 SVG 文件,因为它们更易于搜索和修改。我们的 Mermaid 图表基于 rehype-mermaid ↗ 和 mermaid ↗。
按如下方式格式化 Mermaid 图表:
```mermaid
flowchart LR
accTitle: Tunnels diagram
accDescr: The example in this diagram has three tunnel routes. Tunnels 1 and 2 have top priority and Tunnel 3 is secondary.
subgraph Cloudflare
direction LR
B[Cloudflare <br/> data center]
C[Cloudflare <br/> data center]
D[Cloudflare <br/> data center]
end
A((User)) --> Cloudflare --- E[Anycast IP]
E[Anycast IP] --> F[/Tunnel 1 / <br/> priority 1/] --> I{{Customer <br/> data center/ <br/> network 1}}
E[Anycast IP] --> G[/Tunnel 2 / <br/> priority 1/] --> J{{Customer <br/> data center/ <br/> network 2}}
E[Anycast IP] --> H[/Tunnel 3 / <br/> priority 2/] --> K{{Customer <br/> data center/ <br/> network 3}}
```例如,渲染效果如下:
flowchart LR
accTitle: Tunnels diagram
accDescr: The example in this diagram has three tunnel routes. Tunnels 1 and 2 have top priority and Tunnel 3 is secondary.
subgraph Cloudflare
direction LR
B[Cloudflare <br/> data center]
C[Cloudflare <br/> data center]
D[Cloudflare <br/> data center]
end
A((User)) --> Cloudflare --- E[Anycast IP]
E[Anycast IP] --> F[/Tunnel 1 / <br/> priority 1/] --> I{{Customer <br/> data center/ <br/> network 1}}
E[Anycast IP] --> G[/Tunnel 2 / <br/> priority 1/] --> J{{Customer <br/> data center/ <br/> network 2}}
E[Anycast IP] --> H[/Tunnel 3 / <br/> priority 2/] --> K{{Customer <br/> data center/ <br/> network 3}}
一张图表,描绘 Cloudflare 平台的全部或部分,以及 Cloudflare 如何与客户的基础设施或用例对齐。
展示与特定基础设施或用例对齐的完整 Cloudflare 架构。尽可能使用 SVG。
例如:
注意:此图像中的标签可能反映旧的产品名称。