1. 基本结构1.1 必要元素元素要求说明表号必须格式“表 X-Y”X 为章号Y 为序号如表 3-2表题必须简明概括表格内容位于表号下方表头必须每列第一行说明该列数据性质表体必须实际数据内容表注可选对表格内容的补充说明位于表格下方✅ 正确示例表 3-2 系统配置参数 | 参数名 | 默认值 | 取值范围 | 说明 | |:---------|:-------|:-----------|:---------------| | timeout | 30 | 1-3600 | 连接超时时间秒 | | retry | 3 | 0-10 | 失败重试次数 | | pool_size| 10 | 1-100 | 连接池大小 | 注取值范围为空表示无限制。1.2 表格类型选择类型适用场景结构特点对照表参数说明、术语对照两列术语/参数 解释矩阵表功能对比、版本差异多行多列行与列有对应关系流程表操作步骤、状态流转按时间或逻辑顺序排列汇总表数据统计、结果汇总末行常为合计或总结✅ 对照表示例表 4-1 常见错误码对照 | 错误码 | 含义 | 处理建议 | |:-------|:---------------|:-------------------------| | E1001 | 数据库连接失败 | 检查网络配置和数据库状态 | | E1002 | 认证信息无效 | 确认令牌未过期且格式正确 | | E1003 | 权限不足 | 联系管理员分配相应权限 |✅ 矩阵表示例表 4-2 功能版本对照 | 功能 | 社区版 | 专业版 | 企业版 | |:---------------|:-------|:-------|:-------| | 基础监控 | ✓ | ✓ | ✓ | | 告警通知 | ✗ | ✓ | ✓ | | 自动扩容 | ✗ | ✗ | ✓ | | 专属技术支持 | ✗ | ✗ | ✓ |2. 内容规范2.1 数据准确性要求说明检查方法数据真实表格数据必须与正文或实际系统一致与代码、配置文件交叉验证单位统一同一列数据单位必须一致在表头或表注中统一标注格式统一同类数据格式一致时间格式、小数位数、大小写来源标注引用数据需注明来源在表注中说明数据来源✅ 正确示例表 5-3 性能测试数据 | 场景 | 并发数 | 平均响应时间(ms) | 错误率(%) | |:-------------|:-------|:-----------------|:----------| | 简单查询 | 100 | 12.5 | 0.00 | | 复杂报表 | 50 | 245.8 | 0.02 | | 批量导入 | 10 | 1890.0 | 0.15 | 注测试环境为 8C16G数据量 100 万条。❌ 错误示例表 5-3 性能测试数据 | 场景 | 并发数 | 响应时间 | 错误率 | |:-------------|:-------|:----------|:---------| | 简单查询 | 100 | 12.5 ms | 0 | | 复杂报表 | 50 | 0.2458 s | 0.02% | | 批量导入 | 10 | 1890 | 0.15 |错误原因响应时间单位混用ms/s/无单位错误率格式混用整数/百分数/小数。2.2 内容精简规范要求正确示例错误示例避免冗余不在单元格重复表头信息“30”“超时时间30秒”避免长文本单元格内容不超过 20 字“支持自动故障转移”“支持自动故障转移功能当主节点宕机时自动切换至备节点”统一术语与正文术语保持一致“连接池”连接池/Connect Pool混用2.3 空白单元格处理场景处理方式示例说明数据不适用填充N/A或-“N/A”Not Applicable明确标识不适用数据暂缺填充TBD或待补充“TBD”To Be Determined后续补充数据无限制填充无限制或∞“无限制”与空单元格区分数据为零填写0“0”必须与空白单元格区分默认继承填充同上或↑“同上”与上方单元格内容相同✅ 正确示例表 6-1 模块兼容性 | 模块 | Windows | Linux | macOS | |:---------|:--------|:------|:------| | 核心引擎 | ✓ | ✓ | ✓ | | 图形界面 | ✓ | ✓ | N/A | | 硬件加速 | ✓ | TBD | N/A | | 远程调试 | 同上 | ✓ | 同上 |N/A标识不适用TBD标识待补充同上避免重复填写。❌ 错误示例表 6-1 模块兼容性 | 模块 | Windows | Linux | macOS | |:---------|:--------|:------|:------| | 核心引擎 | ✓ | ✓ | ✓ | | 图形界面 | ✓ | ✓ | | | 硬件加速 | ✓ | | | | 远程调试 | | ✓ | |错误原因空白单元格语义不明无法区分是不适用、待补充还是数据缺失。2.4 重复内容处理场景处理方式正确示例错误示例整列内容相同删除该列在表注中统一说明表注“所有参数均支持动态热更新”重复填写支持整行内容相同合并为单行用通用或全部概括“全部平台支持安装”多行重复相同内容部分单元格重复使用同上、“↑”、-等符号“同上”重复填写相同文字周期性重复提取重复模式简化表格按类别分组而非逐行罗列逐行重复相同前缀✅ 正确示例整列相同表 7-1 参数热更新支持 | 参数名 | 默认值 | 取值范围 | |:---------|:-------|:-----------| | timeout | 30 | 1-3600 | | retry | 3 | 0-10 | | pool_size| 10 | 1-100 | 注所有参数均支持动态热更新无需重启服务。不在表格中增加热更新列全部填是而在表注统一说明。✅ 正确示例部分重复表 7-2 分区域部署配置 | 区域 | 节点数 | 机型 | |:---------|:-------|:-----------| | 华北-北京 | 5 | 8C16G | | 华北-天津 | 同上 | 同上 | | 华东-上海 | 8 | 16C32G | | 华东-杭州 | 同上 | 同上 |同上避免重复填写节省空间且便于维护。❌ 错误示例表 7-2 分区域部署配置 | 区域 | 节点数 | 机型 | |:---------|:-------|:-----------| | 华北-北京 | 5 | 8C16G | | 华北-天津 | 5 | 8C16G | | 华东-上海 | 8 | 16C32G | | 华东-杭州 | 8 | 16C32G |错误原因重复数据未合并修改时需多处同步易遗漏。2.5 排序规则场景排序方式示例有自然顺序按时间、大小、优先级排序开发→测试→生产无自然顺序按字母或拼音排序参数名按字母排序有重要性差异按重要性降序排列致命→严重→一般→提示对照表与正文出现顺序一致按正文提及顺序排列3. 排版规范3.1 对齐方式数据类型对齐方式示例文本左对齐参数名、描述数字右对齐数值、百分比状态标识居中对齐✓/✗、是/否混合内容左对齐含数字的文本如版本 3.2.1✅ 正确示例表 6-1 资源配额 | 项目 | 配额(个) | 已使用(个) | 剩余(个) | |:---------|---------:|-----------:|---------:| | 实例 | 100 | 45 | 55 | | 存储(GB) | 500 | 120 | 380 | | 带宽(Mbps)| 100 | 60 | 40 |文本左对齐数字右对齐便于比较大小。3.2 行列控制规范要求处理方式列数限制不超过 7 列超过时分拆为多个表格或转置行数限制不超过 20 行超过时拆分为多个表格或附录展示列宽控制根据内容自适应避免过宽长文本换行或截断后表注说明表头换行允许但不超过 2 行精简表头文字或缩写后表注说明3.3 视觉样式元素规范说明表头背景区别于表体的底色或加粗增强辨识度分隔线表头下方、末行上方加粗横线区分表头、表体、表注字体表头可加粗表体常规不可全表加粗颜色仅用黑白灰禁用彩色确保打印可读性✅ 正确示例Markdown 模拟表 7-1 兼容性矩阵 | 浏览器 | 版本要求 | 支持状态 | |:--------|:---------|:--------:| | Chrome | ≥ 90 | ✓ | | Firefox | ≥ 88 | ✓ | | Safari | ≥ 14 | ✓ | | IE | 全部 | ✗ | | Edge | ≥ 90 | ✓ |4. 与正文的配合4.1 引用规范要求规范正确示例错误示例必须引用表格必须在正文中被提及“详见表 3-2”表格突兀出现正文未提及引用位置表格出现在首次引用之后先写配置参数见表 3-2再出现表格表格在前引用在后引用格式“见表 X-Y或如表 X-Y 所示”“超时时间默认值见表 3-2”“见下面的表”解释说明正文需说明表格核心结论“表 3-2 显示timeout 默认值为 30 秒”仅写见表 3-2无解读✅ 正确示例系统配置参数需根据实际环境调整。关键参数默认值及取值范围见表 3-2。 表 3-2 系统配置参数 | 参数名 | 默认值 | 取值范围 | 说明 | |:---------|:-------|:-----------|:---------------| | timeout | 30 | 1-3600 | 连接超时时间秒 | | retry | 3 | 0-10 | 失败重试次数 | 如表 3-2 所示timeout 默认 30 秒适用于内网环境广域网建议调整为 60-90 秒。4.2 内容互补原则说明处理方式正文为主表格为辅表格不重复正文已详细说明的内容正文讲原理表格列数据表格概括正文展开正文对表格关键数据进行解读表格列对比数据正文分析差异避免矛盾表格与正文数据必须一致修改时同步更新✅ 正确示例正文 系统支持三种部署模式各自适用场景及资源要求不同见表 8-1。单机模式适用于开发测试资源占用最低集群模式适用于生产环境提供高可用保障。 表 8-1 部署模式对比 | 模式 | 节点数 | 内存要求 | 适用场景 | |:-------|:-------|:---------|:-------------| | 单机 | 1 | 2GB | 开发测试 | | 主备 | 2 | 4GB | 小型生产 | | 集群 | ≥3 | 8GB | 大型生产 |正文说明差异和适用场景表格提供具体数据互为补充。4.3 位置安排规范要求说明就近原则表格紧跟首次引用段落不宜跨页或跨章节独立成块表格前后各空一行与正文区分避免拆分表格尽量在同一页长表格可调整行列或放附录5. 规范速查表类别核心规范检查要点基本结构表号、表题、表头、表体必备表注可选四要素是否齐全表号格式是否正确内容规范数据真实、单位统一、格式统一、术语一致数据是否与系统一致单位是否混用术语是否与正文一致空白单元格不适用填N/A暂缺填TBD无限制填无限制为零填0重复填同上空白单元格是否有明确语义标识是否与零值区分重复内容整列相同删列改表注整行相同合并部分重复用符号周期性重复提取模式是否存在可合并的重复数据是否使用同上等符号排版规范文本左对齐、数字右对齐、列≤7、行≤20对齐方式是否正确行列是否超标与正文配合必须引用、位置就近、内容互补、解释结论正文是否提及是否解读关键数据是否互为补充