在說明文件中加入圖表

在說明文件中，圖表可用於說明工程概念和指南。不過，請務必確保 fuchia.dev 上的圖表可供存取及更新。本指南將說明如何在 Fuchsia 說明文件中加入可維護的圖表。

圖表類型

• 根據原始碼中的文字產生簡單的流程圖 (例如：序列圖或 Googlers 專用的 go/sequencediagram)

• 在 Google 繪圖、Google 簡報或其他工具中建立圖表

如何新增視覺圖表

如果您要為 fuchsia.dev 上的文件建立圖表，請按照下列步驟操作：

1. 使用所選工具建立視覺化圖表，並將圖片匯出為 .svg (建議) 或 .png 檔案

• 請對圖片進行最佳化，確保圖片能快速載入。大型圖片可能會導致網頁載入時間變慢。
• 盡可能使用 SVG (可縮放向量圖形) 格式。相較於其他圖片格式，SVG 可調整大小、可存取，且檔案大小較小。

1. 使用 Markdown 在 fuchsia.dev 上嵌入圖片 (請參閱操作說明)

• 將圖片儲存在與 Markdown 檔案相同的目錄中

1. 為圖片新增替代文字。替代文字可協助螢幕閱讀器使用者瞭解圖片內容。

![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 說明文件的所有圖表中維持一致的樣式和視覺語言。

國際化：盡量減少圖表中的文字。如果需要文字，請確保文字可翻譯及本地化。盡可能使用普遍認可的符號和圖示。

設計須知

視覺階層：使用清晰且一致的視覺階層，引導讀者瀏覽圖表。使用空白字元來建立視覺區隔，改善可讀性。

顏色：使用足夠的色彩對比，確保視障使用者能清楚閱讀內容。避免使用顏色做為傳達資訊的唯一方式。

可擴充性：請確保圖表可擴充，且可放大顯示而不失清晰度。

替代文字

為所有圖表提供簡明扼要的替代文字說明。替代文字應符合以下條件：

• 準確描述圖表的內容和用途
• 使用簡單易懂的語言
• 簡明扼要，避免提供不必要的詳細資訊
• 如果示意圖含有文字，請在替代文字中加入該文字

替代文字範例