1. 图形类型
1.1 架构图
| 子类型 | 适用场景 | 核心元素 |
|---|
| 系统架构图 | 展示系统整体结构 | 模块、层次、交互关系 |
| 部署架构图 | 展示物理或逻辑部署 | 服务器、网络、存储、地域 |
| 数据架构图 | 展示数据流转与存储 | 数据源、处理节点、存储、流向 |
✅ 正确示例：
系统架构图应清晰展示接入层、业务层、数据层的模块划分及调用关系。
1.2 流程图
| 子类型 | 适用场景 | 规范符号 |
|---|
| 业务流程图 | 业务操作步骤 | 开始/结束（椭圆）、处理（矩形）、判断（菱形） |
| 数据流程图 | 数据流转过程 | 数据存储（开口矩形）、外部实体（矩形）、处理（圆角矩形） |
| 状态转换图 | 状态机、生命周期 | 状态（圆角矩形）、转换（箭头）、事件（标注） |
1.3 示意图
| 子类型 | 适用场景 | 特点 |
|---|
| 界面截图 | 展示操作界面 | 标注关键操作区域，去除敏感信息 |
| 时序图 | 展示交互时序 | 对象生命线、消息箭头、激活条 |
| 类图/ER图 | 展示代码或数据模型 | 遵循UML规范，标注关键属性 |
| 拓扑图 | 展示网络或集群结构 | 节点、连线、标签清晰 |
1.4 数据可视化
| 类型 | 适用场景 | 规范 |
|---|
| 折线图 | 趋势变化、性能曲线 | 坐标轴标注单位，图例清晰 |
| 柱状图 | 对比数据、分类统计 | 柱宽一致，间距适当 |
| 饼图 | 占比分布 | 类别不超过6个，标注百分比 |
| 热力图 | 密度、频率分布 | 色阶清晰，附色标说明 |
2. 图形使用时机
2.1 必须使用图形的场景
| 场景 | 原因 | 替代方案 |
|---|
| 复杂架构说明 | 文字描述冗长且难以理解 | 无 |
| 多步骤流程 | 纯文字步骤超过5步 | 流程图+简要文字 |
| 数据对比 | 多组数据对比 | 表格或图表 |
| 界面操作指导 | 需精确定位操作位置 | 截图+标注 |
| 性能趋势 | 展示变化规律 | 折线图 |
2.2 禁止使用图形的场景
| 场景 | 原因 | 替代方案 |
|---|
| 简单概念说明 | 文字即可清晰表达 | 段落描述 |
| 少量数据展示 | 图形反而增加阅读成本 | 表格或内联文字 |
| 敏感信息展示 | 泄露安全信息 | 文字描述或脱敏处理 |
| 动态交互说明 | 静态图形无法表达 | 视频或GIF |
3. 图形设计规范
3.1 视觉规范
| 要素 | 规范 | 说明 |
|---|
| 配色 | 黑白灰为主，彩色不超过3种 | 确保打印清晰，色盲友好 |
| 字体 | 中文宋体/黑体，英文Arial | 字号≥10pt，标注清晰可读 |
| 线条 | 主线1.5pt，辅助线0.75pt | 层次分明，避免过细 |
| 布局 | 从左到右，从上到下 | 符合阅读习惯 |
| 留白 | 边距≥10%，元素间距均匀 | 避免拥挤 |
3.2 内容规范
| 要素 | 要求 | 正确示例 | 错误示例 |
|---|
| 标注 | 关键元素必须标注 | “① 网关层” | 无标注，读者无法识别 |
| 图例 | 符号含义必须说明 | “— 同步调用
–→ 异步调用” | 线条样式无解释 |
| 方向 | 流程方向统一 | 从上到下，从左到右 | 箭头方向混乱 |
| 粒度 | 同一图形粒度一致 | 同为模块级或同为接口级 | 上层模块与底层接口混杂 |
3.3 截图规范
| 要素 | 要求 | 正确示例 | 错误示例 |
|---|
| 完整性 | 展示完整操作窗口 | 包含标题栏、菜单栏 | 仅截取部分区域 |
| 标注 | 红框或箭头标注操作点 | 清晰指示按钮位置 | 无标注或标注模糊 |
| 脱敏 | 隐藏敏感信息 | 密码显示为"******" | 明文展示密码 |
| 时效性 | 使用当前版本界面 | 与文档版本一致 | 界面与版本不匹配 |
4. 编号与标注
4.1 图形编号
| 要素 | 规范 | 示例 |
|---|
| 编号格式 | “图 X-Y”，X为章号，Y为序号 | “图 3-2” |
| 位置 | 图题下方居中 | 图下方 |
| 图题 | 简明概括图形内容 | “图 3-2 系统架构图” |
4.2 图中标注
| 标注类型 | 格式 | 用途 | 示例 |
|---|
| 数字圈注 | ① ② ③ | 对应正文分点说明 | “① 接入层” |
| 字母标注 | A B C | 对应表格或列表 | “区域A” |
| 箭头指引 | → | 指示流向或关联 | 数据流向 |
| 高亮框 | 红框/黄底 | 强调关键区域 | 操作按钮位置 |
✅ 正确示例：
图 3-2 系统架构图 ┌─────────────────────────────────────┐ │ ① 接入层（Nginx） │ │ 负载均衡、SSL终结 │ └──────────────┬──────────────────────┘ ↓ ┌─────────────────────────────────────┐ │ ② 业务层（微服务） │ │ 用户服务、订单服务 │ └──────────────┬──────────────────────┘ ↓ ┌─────────────────────────────────────┐ │ ③ 数据层（MySQL/Redis） │ │ 主从复制、读写分离 │ └─────────────────────────────────────┘
5. 与正文配合
5.1 引用规范
| 要求 | 规范 | 正确示例 | 错误示例 |
|---|
| 必须引用 | 图形必须在正文中被提及 | “详见图 3-2” | 图形突兀出现 |
| 引用位置 | 图形出现在首次引用之后 | 先写"架构见图 3-2"，再出现图形 | 图形在前，引用在后 |
| 引用格式 | “见图 X-Y”、“如图 X-Y 所示"或"见下图/上图” | “系统架构见图 3-2”
“点击见下图红框标注位置” | “见这里的图” |
| 相对引用 | 图形紧邻时可用"下图/上图" | “配置界面见下图” | 图形距离较远时用"下图" |
| 分点说明 | 对图中标注逐点解释 | “① 接入层：负责…” | 仅写"见图"，无解读 |
5.2 引用方式选择
| 场景 | 推荐引用方式 | 示例 |
|---|
| 图形与引用同页且紧邻 | “见下图/上图” | “系统架构见下图” |
| 图形与引用跨段落或跨页 | “见图 X-Y” | “系统架构见图 3-2” |
| 正式技术文档 | “如图 X-Y 所示” | “系统架构如图 3-2 所示” |
| 多图连续引用 | 混合使用 | “见图 3-2，详细配置步骤见下图” |
5.3 内容互补
| 原则 | 正文职责 | 图形职责 |
|---|
| 正文为主 | 说明设计思路、关键决策、注意事项 | 展示结构、流程、关系 |
| 图形为辅 | 不重复描述图形已清晰表达的内容 | 不承载详细参数和配置 |
| 相互印证 | 文字描述与图形展示一致 | 图形标注与正文术语一致 |
✅ 正确示例（使用"下图"）：
正文： 系统采用分层架构设计，各层职责如下： - 接入层：负责请求分发和SSL终结 - 业务层：处理核心业务逻辑 - 数据层：管理持久化存储 系统架构见下图： [图 3-2 系统架构图] 如上图所示，接入层部署Nginx集群实现负载均衡，业务层采用微服务架构支持独立扩容。
✅ 正确示例（使用"图 X-Y"）：
正文： 系统采用分层架构设计（见图 3-2）。接入层负责请求分发和SSL终结，业务层处理核心业务逻辑，数据层管理持久化存储。各层间通过RESTful API通信，避免直接依赖。 图 3-2 系统架构图 [图形展示三层结构及调用关系] 如图 3-2 所示，接入层部署Nginx集群实现负载均衡，业务层采用微服务架构支持独立扩容，数据层使用MySQL主从复制保障高可用。
5.4 位置安排
| 规范 | 要求 | 说明 |
|---|
| 就近原则 | 图形紧跟首次引用段落 | 不宜跨页或跨章节 |
| 独立成块 | 图形前后各空一行 | 与正文区分 |
| 避免拆分 | 图形尽量在同一页 | 大图可放附录或折页 |
| 清晰度 | 分辨率≥150dpi，矢量图优先 | 放大不失真 |
6. 规范速查表
| 类别 | 核心规范 | 检查要点 |
|---|
| 图形类型 | 架构图、流程图、示意图、数据可视化按需选择 | 类型是否匹配内容？是否滥用或缺失？ |
| 使用时机 | 复杂架构、多步骤流程、数据对比、界面操作必须用；简单概念、少量数据、敏感信息禁用 | 是否该用图形？是否可用文字替代？ |
| 设计规范 | 配色≤3种、字体≥10pt、线条分明、布局合理、留白适当 | 视觉是否清晰？标注是否完整？ |
| 编号标注 | "图 X-Y"格式、图题简明、图中标注清晰 | 编号格式是否正确？标注是否对应正文？ |
| 与正文配合 | 必须引用、位置就近、内容互补、分点解读；紧邻时用"下图/上图"，远离时用"图 X-Y" | 正文是否提及？引用方式是否恰当？是否解读关键元素？ |
