向文档添加图表

图表在文档中非常有用，有助于说明工程概念和指南。不过，请务必确保 fuchsia.dev 上的图表可访问且可更新。本指南介绍了如何向 Fuchsia 文档添加可维护的图表。

图表类型

• 根据源代码中的文本生成简单的流程图。选项：

  • Mermaid：这是一种简单的方法，可用于维护从源代码中的文本生成的图表
  • 序列图：使用源代码中的文本创建基本流程图
  • （仅限 Google 员工）go/sequencediagram：序列图工具的内部版本

• 在 Google 绘图、幻灯片或其他工具中创建可视化图表

如何添加可视化图表

如果您要为 fuchsia.dev 上的文档创建可视化图表，请按以下步骤操作：

1. 在您选择的工具中创建可视化图表，然后使用 Mermaid 等工具的代码块，或将图片导出为 .svg（推荐）或 .png 文件。

   对于图片，请务必执行以下操作：

   • 优化图片，确保其快速加载。大图片可能会增加网页加载时间。
   • 尽可能使用 SVG（可缩放矢量图形）格式。与其他图片格式相比，SVG 可扩缩、可访问且文件更小。

2. 使用 Markdown 在 fuchsia.dev 上嵌入图片。例如：请参阅说明。

   美人鱼

   Markdown

   
   ```mermaid
   graph LR
   A[Square Rect] -- Link text --> B((Circle))
   A --> C(Round Rect)
   B --> D{Rhombus}
   C --> D
   ```
   
   

   html

   
   <pre class="mermaid">
     graph LR
     A[Square Rect] -- Link text --> B((Circle))
     A --> C(Round Rect)
     B --> D{Rhombus}
     C --> D
   </pre>
   
   

   已渲染：

   .svg/.png

   请务必为图片添加替代文本。替代文本有助于屏幕阅读器用户了解图片内容。例如：

   ![Alt text](image_filename.svg)
   

   • 将 Alt text 替换为对图片的简要说明。
   • 将 image_filename.svg 替换为图片的实际文件名。

   例如：

   ![A flowchart showing the boot process of a Fuchsia device. The process starts
   with the bootloader, then moves to Zircon kernel, and finally to the user
   space.](component_framework.svg)
   

有关图表的用户体验指南

图表是一种实用的工具，可提供仅通过文字难以传达的额外清晰度或背景信息。有效的图表应直接支持和增强文档中的随附文本。

• 聚焦：每个图表都应有一个明确的聚焦点，并传达特定的概念或想法。为所有元素提供清晰简洁的标签。

• 简单：力求视觉清晰。避免过于复杂或视觉上杂乱，以免让读者感到困惑。

• 一致性：在 Fuchsia 文档中的所有图表中保持一致的风格和视觉语言。

• 国际化：尽量减少图表中的文字。如果需要文本，请确保其可翻译和本地化。尽可能使用普遍认可的符号和图标。

设计考虑事项

• 视觉层次结构：使用清晰且一致的视觉层次结构引导读者浏览图表。使用空格来实现视觉分隔并提高可读性。

• 颜色：使用足够高的颜色对比度，确保视障用户能够轻松阅读。避免将颜色作为传达信息的唯一方式。

• 可伸缩性：确保图表可伸缩，并且可放大而不会失去清晰度。

替代文本

为所有图表提供简明扼要且信息丰富的备用文本说明。替代文本应：

• 准确描述图表的内容和用途
• 使用通俗易懂的语言
• 简明扼要，避免添加不必要的细节
• 如果图表包含文字，请在替代文本中添加该文字

替代文本示例：

显示 Fuchsia 设备启动过程的流程图。该过程从引导加载程序开始，然后移至 Zircon 内核，最后移至用户空间。	流程图的图片。（过于笼统，缺少信息）
正确做法	错误做法

一张图，展示了 Fuchsia 组件框架中组件之间的关系。组件按层次结构排列，父级组件位于顶部，子级组件位于底部。	包含框和箭头的示意图。（描述性不够）
正确做法	错误做法