文档代码评审流程.ppt

文档/代码评审流程 2010/07/05 目录 评审工作的目的 角色和职责 工作流程 操作指南 相关表格和模板 评审工作的目的 提高文档/代码质量，减少各种无形损失 尽早发现各种潜在问题 增进相关人员的沟通和讨论 提高相关人员的设计水平和文档水平 角色和职责 作者/Author 对文档/或代码的质量负最直接责任 评审主持人/Moderator 保证评审过程规范性、一致性 评审人/Reviewer 掌握相关知识、进行评审活动、记录所有发现的缺陷 质量保证人员/QA 作为第三方对整个过程进行审计 跟踪关键步骤 检查输入、输出项 工作流程 操作流程 – 申请评审 确定评审主持人 建议由具备一定经验的员工担任 必要时请项目经理协助指定 准备相关文档资料 帮助评审人了解待评审文档 操作流程 – 准入检查 文档 格式检查，是否符合相关模板 代码 编译通过 辅助工具检查（如有） 创建标签(Tag)保存被评审版本 文档/代码及所有资料发送给评审主持人 操作流程 – 评审计划 确定评审人 项目级文档（例如项目系统需求） 本项目核心开发人员 与本项目有直接接口的相关部门代表 技术支持 中试 心电部？ 结构部？ 项目内文档（例如设计文档、模块测试文档） 项目架构师 开发人员 测试人员 操作流程 – 评审计划(续) 决定是否需要启动会议 启动会议适用于评审人对于待评审文档/代码内容不熟悉的情况，进行基本介绍 如果需要，预订会议室，通知召开会议（邮件模板1） 准备文档和评审记录表 文档加行号 Word菜单 File-Page Setup…-Layout-Line Numbers… 代码打包压缩 评审记录表中填写本次评审的基本信息 预订正式评审会议的会议室 提前2-4天把所有文件发送给评审人，抄送文档作者、项目经理及其他可能的相关人员（邮件模板2） 操作流程 – 评审工作 评审人阅读文档/代码，记录反馈意见 填写评审记录表中”缺陷记录”页的C,D,E,F,G列，评审会议召开前回复给评审主持人 G列反馈意见类型 M: Major, 主要缺陷 S: Small, 次要缺陷 T: Typo, 笔误 Q: Question, 疑问 评审人的工作计划中必须预留出时间 保证评审质量 如果确实没有时间，与项目经理协调，调整评审计划或调整评审人名单 操作流程 – 正式评审会议 评审主持人在会议召开前汇总所有反馈 评审会议上 记录评审人的评审工作所耗时间 澄清每条反馈信息，主持讨论 F列(描述) 更新会上的讨论结果 G列(类型) 类型为Q的反馈，讨论后更改为M, S或T的其中一类 H列(结论) A: Accept, 接受 R: Reject, 拒绝 C: Check, 待确认 I列(状态) 评审会议结束时，所有反馈的状态均为”Open” 操作流程 – 评审后续 评审主持人整理评审报告表，填写”评审报告”页中的各项统计信息 发送评审记录表给所有到会人员（邮件模板3） 作者更新文档/代码 H列(结论)为A：根据描述更新 H列(结论)为C：和相关人员确认，最终定论为A或R 更新完成后将第I列(状态)改为“Close” 更新后的文档/更新后的代码版本号(SVN Revision No.)和评审记录表发送给评审主持人检查 操作流程 – 评审结束 评审主持人发送邮件通知所有相关人员评审结束（邮件模板4） 对于文档评审 申请质量控制人员进行审计（如有） 审计通过后文档在项目内正式发布 对于代码评审 评审结束后按照项目计划进行下一步工作（例如单元测试或模块测试） 这一过程中不涉及代码发布 相关表格和模板 XXXX文档_评审记录表 XXXX代码_评审记录表 相关表格和模板 邮件模板1 评审启动会议 邮件模板2 正式评审会议 相关表格和模板 邮件模板3 发送评审结果 邮件模板4 通知评审结束 致谢！ * [作者]: 确保文档/代码质量符合基本要求 [评审主持人]: 决定是否需要召开启动会议，确定评审人，准备评审表格，安排正式评审会议 [作者]: 简要介绍文档/代码 [评审主持人]: 说明评审工作流程、范围和职责 [评审人]: 审查被评审项，在评审记录表中填写所有反馈，并发送给评审主持人 [评审主持人]: 收集并汇总所有反馈 [评审主持人]: 组织讨论，澄清所有反馈，记录讨论内容，决定每一项反馈的后续动作 [评审主持人]: 如果文档/代码质量不能被通过，组织该会议进行原因分析 [作者]: 根据第一次评审的结果修改文档/代码 [评审主持人]: 总结评审报告；监督作者后续工作，跟踪所有反馈的结束状态 [作者]:根据评审反馈更新文档/代码 [作者]: 确定评审主持人，准备相关文档资料 [作者]: 文档进行格式检查，代码进行编码规则检查 [评审主持人]: 发送邮件通知文档/代码完成