技术文档中的图表

技术图表本身就是一种文档形式。但它们也常用于补充技术文档撰写团队和文档团队创建的其他类型文档中的文本。虽然有些团队可能由图形设计师负责绘制图表，但技术文档撰写人员可能不太熟悉。

我们之前已经探讨过各种职业如何需要绘制特定的技术图表，但文档团队经常需要在许多不同的领域进行写作和绘制图表。

对于此类文档团队来说，以下概述很有帮助：哪些类型的技术文档通常包含技术图？

本页所有技术图表均使用 draw.io 创建。

用户文档

用户文档包含软件应用程序或实体产品的使用说明。这些文档中最常见的图表包括流程图、带标签的模型图或照片以及解释性信息图。

1. 安装指南和软件用户手册——流程图、带标签的界面模型

2. 产品手册——带标签的图表和照片、流程图、信息图

3. 用户安全信息 ——流程图、安全隐患信息图

4. 故障排除-表格、流程图

使用国际认可的图标来表示产品的安全、使用、保养或处置程序，这样在产品销往国际市场时，需要翻译成其他语言的内容就会减少。

如果您的用户文档以电子版形式提供，请在图表中添加指向各个形状的链接，以便用户可以直接跳转到所需信息。这对于故障排除说明尤其有用。

产品开发文档

1. API 和 SDK 文档- 数据流图、UML 图、C4 模型、依赖关系图

2. 技术规范——UML和SysML图、模型图、实体关系图、用户流程图、PERT图和依赖关系图、时序图

3. 项目管理文档——概念图、时间表和路线图、甘特图、看板、Gitflow流程图

4. 系统架构——网络和基础设施图、机架图

5. 技术设计——CAD图纸、剖面材料图、模型、线框图

作为一款在线白板工具，draw.io 适用于分布式团队项目会议，支持在 Confluence Cloud、Google Drive 和 OneDrive 中进行实时协作编辑。您仍然可以在这些快速白板图中运用 draw.io 的所有技术图表绘制功能——包括丰富的形状库、样式自定义和精确的形状编辑工具——以及使用便捷的模板快速完成工作。

无论你在哪里管理项目文档，都可以绘制图表。

如果您使用 VS Code 来编写项目文档，您可以安装Henning Dieterichs 的非官方 draw.io 扩展程序，以便查看和编辑存储在 GitHub 中的图表，以及您的代码和 markdown 文档。

GitLab在 15.10 版本中将draw.io 集成到了 GitLab wiki 编辑器中。

draw.io 的 Jira 应用还允许您将图表直接附加到问题和服务台工单，或者嵌入存储在 Confluence、Google Drive 或 OneDrive 中的图表文件。

如果您使用 Notion，请添加 draw.io Chrome 扩展程序，以便将您的图表存储在 Notion 页面中。

制造文档

1. 供应链文档——审批流程、供应流程、安全网络可视化

2. 制造文档——机器图纸、事件驱动流程链、电气和控制电路图、生产流程图、价值流图、石川图、制造模型、时序图、框图

3. 可视化辅助工具——仪表盘、信息图表、带标签的图表和照片、场地地图和平面图

质量、安全和法律文件

1. 设备维修手册——故障树、带标签的图表、故障排除流程图、零件图

2. 风险文档——威胁模型、系统模型、FRAM模型、生态接口、决策树、时序图、事件响应时间线、概率树和风险概述

虽然并非严格意义上的文档，但用于跟踪制造过程中生产指标的显示器上的数据驱动型仪表盘通常最初是以图表的形式呈现的。与文本表格或状态指示灯相比，工厂车间或机器的可视化图表更容易让操作员一目了然。在小型公司中，图形设计师/文档专家可能负责创建初始的仪表盘布局。

技术业务文档

尤其是在需要向董事会汇报的大型企业中，业务流程需要清晰地记录下来，以明确角色和职责，并支持定期的安全和会计合规性审计。以图表形式呈现此类文档更易于理解。

1. 业务流程图——流程图、BPMN图、泳道图、UML序列图、角色与职责图

2. 汇报或决策链——组织结构图、信息图、维恩图和气泡图、演示图表

3. IT基础设施——网络图、机架图、数据库和实体关系模型

对于需要证明合规性的受监管行业，标准操作规程 (SOP) 会详细记录如何执行流程或任务，包括安全、质量、工具、机械和材料信息。某些行业可能要求使用特定的技术格式——例如，draw.io 中的流体动力形状库（用于符合 ISO1219 标准）或 BPMN 图（用于记录业务流程）。

市场营销和销售文件

虽然这些通常不被视为技术文档，但以下文档可以而且经常包含图表，以吸引和说服潜在客户或投资者。将图表导出为 PNG 文件，并将这些图像文件嵌入到您的商务演示文稿和文档中。

1. 白皮书和案例研究——简明流程图、概念图、时间轴、维恩图和信息图

2. 市场分析——PEST分析图、SWOT分析表、T型图、5C分析图、时间线、户型购买热力图

3. 广告和营销活动——客户旅程、依赖关系图、故事地图、甘特图

draw.io 让您轻松地将图表嵌入各种文档格式，并与受众分享。使用draw.io 应用，您可以将云存储中的 draw.io 图表直接嵌入到Office和Workspace文档中。您甚至可以将 draw.io 图表直接嵌入到 HTML 网页的iFrame 中，供在线受众查看，或者分享包含图表数据的 URL。

技术图表绘制最佳实践

技术文档的最佳实践同样适用于技术图表：

• 将文档和图表集中放在一个地方——确保只有一个信息来源。

• 使用版本控制跟踪图表变更。

• 建立定期审核流程，确保图表保持最新或存档。

• 图表应尽可能简洁明了，以便于阅读。

• 遵循样式指南或使用符号标准有助于保持某些类型图表的一致性。

draw.io 允许您将图表与文档一起保存：在 Confluence 和 Jira 中；存储在 Google Drive、Microsoft OneDrive 或 Dropbox 等云平台上；在 GitHub 或 GitLab 中；或者在公司的基础架构中。

查看所有 draw.io 集成列表