跳转到内容
搜索文档

屏幕截图

最后更新 查看 MarkdownAgent 设置

屏幕截图是软件工具的图片,在这种情况下通常是 Cloudflare 仪表板的图片。

我们仅在特定场景中推荐使用屏幕截图,因为与其他类型的内容相比,它们具有更高的维护成本

何时使用

克制且有目的地使用屏幕截图。例如,当任务简单但经常令用户困惑,或者很难仅用语言描述时,使用屏幕截图是合适的。

一个典型的例子是查找账户和区域 ID,因为:

  • 它是向我们的社区(Community)引流 SEO 流量的主要来源。
  • 我们曾尝试仅用文字解释,但这并没有解决困惑。
  • 这是一个专门针对新用户的任务,他们对 Cloudflare 的概念或导航模式不太熟悉。

指南

屏幕截图应该:

  • 保持原始纵横比锁定。
  • 保持分辨率为 72dpi。
  • 保持宽度在 500-600 像素之间。
  • 避免分享敏感信息(您可能需要在浏览器中编辑底层的 HTML)。
  • 避免包含频繁变化的视觉元素,例如侧边栏导航。
  • 拥有描述性的替代文本(alt text)。

用法

![替代文本](~/assets/images/$PRODUCT_NAME/$IMAGE_NAME.png)

将屏幕截图添加到 /src/assets/images/ 下相应的 $PRODUCT_NAME 文件夹中。为了便于组织,您可能需要添加子文件夹。

维护

我们避免使用没有明确目的的屏幕截图,因为它们很难维护。这是因为:

  • UI 可能会改变,而我们的团队可能并不知道。
  • 即使您知道改变了什么,也很难找到哪些屏幕截图可能引用了特定的 UI 流程。
  • 如果发生了变化,您需要重新拍摄完整的屏幕截图来进行替换。这可能涉及添加虚假数据或隐藏敏感信息。

相关组件

这篇文档对您有帮助吗?