第4章 封面与修订记录编写规范

适用场景

封面与修订记录是机器人原型说明书文档体系的门面与版本追溯基线。以下场景必须执行本章规范：

• 首次创建：任何新立项的机器人原型说明书，在生成首个正式版本时。
• 版本迭代：原型进入下一轮开发周期，需要发布新版说明书时。
• 工程更改：因设计变更、BOM调整或软件升级而导致文档内容发生实质性修改时。
• 外部交付：向客户、认证机构或供应链合作伙伴提交正式文档前。
• 归档审计：项目阶段结束或整机验收后，需将说明书封存归档时。

前置条件

开始编制封面与修订记录前，必须确认以下条件已满足：

• 已完成机器人原型的技术内容撰写（至少经过一轮内部自审）。
• 已从项目管理部门获取文档编号前缀与组织编码规则。
• 已确定当前版本的发布类型（初版/修订版/紧急补丁版）。
• 已指定封面所需的编制人、审核人、批准人角色与姓名。
• 已准备统一的封面模板文件（Word / Markdown / LaTeX 源文件）。

操作步骤

本章操作分为三个子流程：封面要素编制 → 版本号命名 → 修订履历表格创建。三个子流程按顺序执行，不可跳跃或颠倒。

步骤一：编写封面要素

1. 确定文档标题：标题必须同时包含“机器人原型”与“说明书”两个核心词，并注明机器人型号或项目代号。格式为“《[产品代号]机器人原型说明书》”。
2. 分配文档编号：依据组织编码规则生成唯一编号。编号应包含项目代号、文档类型码与版本号段。
3. 标注密级：从“公开 / 内部 / 机密 / 绝密”四级中选择，首次发布默认“内部”。
4. 填写角色与签字栏：编制人、审核人、批准人的姓名与签字日期必须完整，不得留空。
5. 确定发布日期：日期格式统一为 YYYY-MM-DD，并对应版本号的创建日期。

步骤二：确定版本号命名规则

机器人原型说明书采用语义化版本号作为主规则，同时允许在特定阶段使用日期版本作为辅助标记。命名规则定义如下：

主版本号.次版本号.修订号
格式：V<major>.<minor>.<patch>

规则说明：
- 主版本号：原型架构重大变更、核心硬件重新选型、不向下兼容时递增。
- 次版本号：功能模块新增、传感器/执行器升级、向下兼容时递增。
- 修订号：Bug修复、文档勘误、非功能性优化时递增。

示例：
初始版本       → V1.0.0
新增导航模块   → V1.1.0
修复电机参数   → V1.1.1
控制器架构重构 → V2.0.0

步骤三：创建修订履历表格

1. 新建表格行：每个版本对应一行，最新版本放在最上方。首次发布时只填写第一行。
2. 填写版本号：必须与封面上的版本号完全一致，包括大写字母“V”和点分隔符。
3. 记录修订日期：日期格式 YYYY-MM-DD，与封面发布日期一致。
4. 撰写修订内容摘要：用一句话概括本次更新的核心变更，使用“新增/修改/修复/删除”作为动词开头。
5. 签字确认：修订人、审核人、批准人三方签字缺一不可。

// 修订履历条目撰写模板
[版本号] [YYYY-MM-DD] 修订人：[姓名]
修订内容：
- 新增：[功能/章节名称]
- 修改：[变更内容]
- 修复：[缺陷描述]
- 删除：[移除内容]

审核人：[姓名]    批准人：[姓名]

输入输出物

责任边界

• 编制人（系统工程师）：负责填写封面所有要素、创建修订记录首行、执行版本号命名规则。对封面与修订记录的完整性和一致性负直接责任。
• 审核人（技术主管）：负责复核封面的密级、版本号与项目当前状态是否匹配，检查修订内容摘要是否准确反映实际变更。审核通过后签注姓名与日期。
• 批准人（项目经理）：对版本发布的时机和范围做最终决策，批准后封面与修订记录即视为生效，任何修改必须进入下一版本。
• 文档管理员：负责将封面与修订记录页纳入文档管理系统，登记版本号并触发归档流程。

记录材料

本章执行过程中需留存以下记录材料，保存期限为项目结束后至少 3 年：

• 封面签字原件：纸质或电子签名版封面页扫描件。
• 版本号登记表：包含每个版本号对应的创建时间、变更摘要、责任人。
• 修订履历历史快照：每次版本发布时的完整修订记录页副本。
• 审核意见单：审核人在复核封面与修订记录时提出的整改意见及闭环记录。
• 编号分配记录：文档编号的申请、审批、分配流水记录。

异常处理

验收标准

封面与修订记录通过验收必须同时满足以下全部条件：

• 完整性：封面要素 9 项全部填写完整，无空栏；修订记录包含从首版到当前版的所有版本行。
• 一致性：封面版本号 = 修订记录最新行版本号 = 文档管理系统登记的版本号。
• 规范性：版本号严格遵循语义化规则，日期格式统一为 YYYY-MM-DD，签字栏使用全名而非缩写或工号。
• 可追溯性：每一行修订记录都能对应到具体的变更申请单或工程更改通知（ECN）编号。
• 审批闭环：编制人、审核人、批准人三方签字齐全，且签字日期不晚于文档发布日期。