表格

技术文档中使用表格建议遵循以下规范。

  1. 样式规范

    • 单元格中的所有内容都建议保持左对齐

    • 所有表格都需要有表头描述,即表格第一行中描述各列内容的短语。

    • 保证表格同一行的单元格不跨页。

    • 每个表格下都要空一行,这一空行的样式为正文。如遇到换页的情况,表格后的空行在新页的第一行,则这行空行必须删除。

  2. 表头规范

    同一技术文档或产品手册中相同类型表格的表头描述需要保持一致。

    【注意】对参数进行说明的表,应该统一表头描述,不要出现“参数说明”、“参数解释”、“参数含义”、“参数意义”等不同的描述。

  3. 单元格内容规范

    • 表格中的内容应该尽量简练,文字表述风格保持一致。避免长篇大段的说明,建议单元格中的内容所占行数不要超过 6 行。

    • 不出现空白的单元格。建议无内容单元格填写“无”或特定含义符号(如“/”)。若使用特定含义符号,需说明符号代表的意义。

    • 单元格内容避免重复。如果多个单元格中的内容相同,建议将内容复制或者采用多个单元格合并的方式,不要使用“同上”。

  4. 表说明规范

    表说明即表格之前或之后的一行表描述,可能带有序号或编号,主要是为了简要描述表格内容。

    • 表说明采用名词词组形式。

    • 表说明简明扼要,长度不能超过表的宽度。

    • 同类表格的表说明在全文中风格保持统一。