第2章 交互描述文档结构：封面、版本记录、目录、正文章节、附录规范

2.1 适用场景

规范的文档结构是交互描述可读、可评审、可追溯的基础。以下场景必须使用本章定义的五部分结构：

• 新项目启动：团队首次编写交互描述文档，需建立统一的结构基线。
• 跨职能评审：交互方案需要产品、开发、测试等多方会审时，标准结构降低沟通成本。
• 资产归档与交接：设计资产需存入团队知识库或交接给后续设计师时，完整结构确保信息不丢失。
• 客户/项目交付：对外交付物要求格式规范、内容完备，五部分结构是默认交付基线。

2.2 前置条件

开始构建文档结构前，必须完成以下准备工作：

• 已完成交互需求的收集与分析，产出《交互需求清单》。
• 已确定核心交互方案与关键用户流程，产出《交互方案线框图》或《任务流程图》。
• 已选定文档编写工具（如 Confluence、语雀、Markdown 编辑器、Word 等），并确认支持版本管理和目录自动生成。
• 已明确文档受众（产品经理、开发工程师、测试工程师、视觉设计师）及评审参与方，以便确定正文内容的颗粒度。

2.3 操作步骤

按照以下五个步骤依次构建文档的每个部分。每一步的产出物将作为下一步的输入。

1. 编写封面 — 包含产品名称、文档标题、版本号、编制日期、编制人、审核人。封面信息必须完整且与文档实际内容一致。

   产品名称：XX 平台 V3.0
   文档标题：购物车交互描述文档
   版本号：V1.0
   编制日期：2025-03-20
   编制人：张三
   审核人：李四

2. 创建版本记录 — 记录每次修订的版本号、日期、修订内容摘要、修订人、审核人。首次发布为 V1.0，每次修订递增末位或中位版本号。

   | 版本号 | 日期       | 修订内容                     | 修订人 | 审核人 |
   |--------|------------|-----------------------------|--------|--------|
   | V1.0   | 2025-03-20 | 初始创建                     | 张三   | 李四   |
   | V1.1   | 2025-03-25 | 修改结算流程分支条件          | 王五   | 李四   |

3. 编制目录 — 基于正文标题层级自动生成或手动维护。目录必须与正文中的 h2/h3/h4 标题完全对应，页码准确。每次正文变更后需同步更新目录。
4. 撰写正文章节 — 按“交互场景描述 → 交互流程定义 → 交互规范说明”三层组织。每一层需包含具体的用户操作、系统响应、前置/后置条件及异常分支。

   2.1 交互场景描述
     2.1.1 用户登录场景
     2.1.2 商品搜索场景
   2.2 交互流程定义
     2.2.1 正常加入购物车流程
     2.2.2 库存不足分支流程
   2.3 交互规范说明
     2.3.1 按钮状态规范
     2.3.2 反馈文案规范

5. 整理附录规范 — 汇总参考资料、术语表、变更记录详情、评审意见记录等。附录中的每一项必须在正文中有对应引用标记。

2.4 输入输出物

2.5 责任边界

2.6 记录材料

本章涉及的文档结构构建过程需保留以下记录材料，用于过程追溯与质量审计：

• 《文档版本记录表》 — 记录每次发布的版本号、日期、修订摘要、审批人。
• 《评审意见记录表》 — 记录评审中提出的结构性问题、归属章节、处理结果。
• 《变更审批记录》 — 涉及封面信息、版本号、章节结构调整时，需留存审批单。

2.7 异常处理

2.8 验收标准

文档结构通过评审需满足以下全部检查项：

• ✅ 文档包含“封面、版本记录、目录、正文章节、附录规范”五个必要部分，无缺失。
• ✅ 封面信息（产品名称、标题、版本号、日期、编制人、审核人）完整且准确。
• ✅ 版本记录中最新版本号与封面一致，历史修订记录可追溯。
• ✅ 目录自动生成，标题层级与正文 h2/h3/h4 完全对应，无错页、无漏项。
• ✅ 正文章节按“场景描述 → 流程定义 → 规范说明”三层展开，每层内容完整。
• ✅ 附录中所有条目在正文中有明确引用标记（如 [附录A] 参考资料），无孤立附录。
• ✅ 所有评审意见已记录在《评审意见记录表》中，且关闭率 ≥ 90%。