前置条件准备
适用场景
前置条件准备适用于所有正式 Solution Design 文档评审活动,确保评审过程在资源到位、材料齐全、角色明确的前提下启动,避免因准备不足导致评审中断或质量下降。典型触发场景包括:
- 新项目阶段评审:架构或详细设计首次提交,需要跨职能团队对齐
- 重大需求变更:已有设计发生实质性修改,需重新验证方案合理性
- 跨部门协同评审:涉及开发、测试、运维、安全、合规等多方,必须统一节奏
- 客户或监管交付:外部要求正式评审记录作为交付物,前置条件需可追溯
- 高风险模块评审:核心链路、数据迁移、安全边界等模块必须零遗漏准备
实践经验:前置条件准备不充分是评审效率低下的首要原因。每次评审前使用本文清单逐项核验,可将评审返工率降低约 40%。
前置条件
启动前置条件准备前,需确认以下基础条件已满足:
- 文档初稿已完成:Solution Design 文档已通过作者自检,格式、术语、版本号基本一致
- 评审主持人已指定:通常由架构师或技术经理担任,负责组织整个评审流程
- 评审标准已定义:评审 Checklist 或评估矩阵已准备,与文档类型匹配
- 文档存储与协作工具就绪:如 Confluence、SharePoint、Git Wiki 等,确保版本可追溯
- 干系人列表已初步识别:知道需要邀请哪些角色,避免遗漏关键决策者
常见疏漏:评审主持人未提前确认自己的职责,或 Checklist 与文档类型不匹配(如用安全 Checklist 审查性能设计),都会导致评审方向偏差。务必在准备阶段对齐评审目标与检查标准。
流程概览
操作步骤
前置条件准备包含四个核心任务,必须按顺序执行,每个任务完成后记录结果。以下为详细步骤:
-
文档完整性检查
- 获取《文档清单》& 《评审 Checklist》,确认文档范围与评审目标一致。
- 根据 Checklist 逐项核验文档是否存在、版本是否正确、是否包含必需章节(背景、约束、架构决策、接口定义、部署方案等)。
- 检查文档格式一致性(术语表、缩略语、引用链接、图表编号)。
- 将检查结果记录在《文档完整性检查表》中,标记缺失或异常项。
- 若发现缺失,立即通知文档作者限期补充,并重新检查直至通过。
# 文档完整性检查表示例(节选) +---------------------------------------+--------+----------+-----------+ | 文档/章节 | 版本 | 状态 | 检查人 | +---------------------------------------+--------+----------+-----------+ | 需求规格说明书 | v1.2 | 已通过 | 张工 | | 系统架构设计 | v2.0 | 已通过 | 李工 | | 接口规范文档 | v1.5 | 缺少第4章| 王工 | | 数据库设计文档 | v1.3 | 已通过 | 赵工 | | 安全合规检查表 | v1.0 | 版本过旧 | 周工 | +---------------------------------------+--------+----------+-----------+ -
评审团队确认
- 根据文档类型和影响范围,确定必须参与的评审角色(架构师、开发负责人、测试负责人、运维代表、安全/合规专家等)。
- 逐一联系候选人,确认其时间可用性及参与意愿;若核心角色不可用,协调备选人员或调整评审窗口。
- 为每位评审成员分配明确职责(如:主审某章节、关注非功能指标、验证接口兼容性等)。
- 在评审邀请中注明角色职责,确保成员提前聚焦。
-
评审材料分发
- 将最终版文档、Checklist、评估表单打包为评审材料包,统一命名格式(如
SD_评审_项目名_v2.0_20250410.zip)。 - 通过既定协作平台(Confluence/SharePoint/邮件)将材料包发送给所有评审成员。
- 设置阅读确认回执,或要求成员在 24 小时内回复“已收到”并确认可以按时完成预审。
- 对未确认成员进行二次提醒,确保无遗漏。
- 将最终版文档、Checklist、评估表单打包为评审材料包,统一命名格式(如
-
评审时间预留
- 根据文档复杂度和评审范围,预估评审会议时长(通常 60–120 分钟),并预留 15 分钟缓冲。
- 在共享日历(Outlook/飞书/钉钉)中创建评审事件,标注会议链接/地点、议程、前置阅读要求。
- 为每位成员发送日历邀请,设定提前 30 分钟提醒。
- 若需使用会议室或评审工具(如 Zoom 白板、Miro),提前完成预订并测试设备。
输入输出物
| 任务 | 输入物 | 输出物 |
|---|---|---|
| 文档完整性检查 | 文档清单、评审 Checklist、Solution Design 文档集 | 《文档完整性检查表》(含通过/异常标记) |
| 评审团队确认 | 干系人列表、角色职责矩阵 | 《评审团队确认表》(成员名单 + 职责分配) |
| 评审材料分发 | 材料包(文档 + Checklist + 评估表单)、分发渠道配置 | 分发记录(含确认回执)、未确认人员清单 |
| 评审时间预留 | 评审时长估算、日历系统、会议室资源清单 | 日历邀请记录、会议室预订确认、提醒配置截图 |
输出物完整性要求:所有输出物必须归档至本次评审的专用目录(如
评审记录/项目X/评审v1/前置条件),作为评审追溯的基线证据。
责任边界
| 角色 | 前置条件准备中的职责 | 验收标准 |
|---|---|---|
| 评审主持人 | 统筹整个准备流程;签发检查表;确认团队就绪;最终签署“前置条件准备完成” | 所有输出物齐全且通过自检 |
| 文档作者 | 提供完整、格式规范的文档;配合完整性检查;按反馈补充缺失内容 | 文档检查表无“缺失”或“版本过旧”标记 |
| 评审成员 | 确认参与意愿;提前接收并预审材料;反馈材料是否可正常打开 | 100% 成员确认收到且无打开障碍 |
| 秘书/协调员 | 执行材料分发;跟踪确认回执;预订会议室/会议链接;发送日历邀请 | 分发记录完整,会议室已锁定,邀请已发送 |
记录材料
前置条件准备阶段必须留存以下记录,作为评审过程资产的一部分:
- 文档完整性检查表:含文档名称、版本、状态、检查人、检查日期
- 评审团队确认表:含成员姓名、角色、职责、确认状态、确认时间
- 材料分发记录:含发送时间、渠道、接收人、回执状态、二次提醒记录
- 时间预留确认记录:含会议主题、日期/时间、地点/链接、邀请发送时间、提醒设置
- 异常处理日志:若准备阶段出现异常,记录异常描述、影响任务、处理方案、处理结果
记录时效建议:每项任务完成后 4 小时内完成记录归档,避免遗忘细节。所有记录使用统一命名模板:
YYYYMMDD_任务名_项目代号。
异常处理
| 异常类型 | 典型表现 | 处理方式 |
|---|---|---|
| 文档缺失 | Checklist 中某章节或附件不存在 | 标记为“阻塞项”,通知作者限期补充;若不能在 24 小时内补齐,评估是否延期评审 |
| 版本不一致 | 同一文档出现多个版本,或与基线版本不匹配 | 与作者确认正确版本,废弃旧版本,在检查表中注明版本切换记录 |
| 核心评审成员不可用 | 架构师或关键领域专家无法参加已定评审窗口 | 优先协调备选专家;若无备选,调整评审时间并重新执行时间预留任务 |
| 材料发送失败 | 邮件被退回、链接失效、附件大小超出限制 | <