CTCA CTCA
登录

6.2 图表与图注

本节规范了技术文档中图表的使用方式和图注的书写要求。

R-115 必须

所有图表必须有图注

技术文档中的每张图片和每个图表都必须配有图注(caption)。图注应简明扼要地描述图表内容或用途,使读者无需仔细查看图表即可了解其要点。图注应位于图表下方,且与图表居中对齐。

R-116 推荐

图表按章节顺序编号

图表编号应采用「图 X-Y」的格式,其中 X 为章节号,Y 为该章节内的图表序号。例如,第 3 章的第 2 张图编号为「图 3-2」。编号应放在图注文本之前,与图注内容之间使用一个空格分隔。整个文档内图表编号必须连续且不重复。

正确

图 3-2 系统架构概览

错误

系统架构图

正确示例包含章节编号和简洁描述,方便在正文中交叉引用(如「参见图 3-2」)。错误示例缺少编号,无法被精确引用,且描述过于笼统。

提示

图表类型选择建议:流程说明使用流程图,数据对比使用柱状图或折线图,层级关系使用树形图,系统组件关系使用架构图。选择合适的图表类型可以更有效地传达信息。对于复杂的系统架构图,建议同时提供文字说明。