在一个项目的开发过程中会涉及到很多的文档,无论你是采用RUP还是XP的开发过程。为什么现在大家一直强调文档的重要性?你去看看中国现在所能查到的历史是写在什么地方就知道了,因为中国的历史都是写在纸上,让大家有史可查,当然也有一部分是写在龟壳上的,意思就是说什么东西都要有个记录,以便查询和跟踪。
在这里,我总结了一个项目从立项到结项的过程中会涉及到的一些文档,给大家一个参考。但没有什么东西是一尘不变的,文档的多少和编写还是以具体的项目而灵活变化,其实文档也反映了一个项目的开发过程。
以下总结的,是可以马上就在项目中用到的文档,但如果你研究过RUP,你一定会知道一个大系统的文档远不止这些。我第一次接触RUP的时候,那个博士就告诉我,RUP是要裁剪的应用。
下面的文字我参考了RUP还有以前在广州收集的一些资料,怀念那段舒服的时光。也感谢我的小毛球,我在写这些东西的时候,它正趴在我的腿上,让我丝毫不敢乱动。
1
.
立项管理
1.1 立项建议书 (由业务部和技术部共同提交该文档,在项目开始业务人员就应于技术人员沟通,大家一起喝喝下午茶,尽快让大家对新系统达成共识)
1.2 立项可行性分析报告 (从经济,技术,当前政策,知识产权分析。)
1.3立项评审报告 (交给项目经理去搞定吧)
2
.
项目规划
2.1项目估计表 (从硬件,软件,人员,项目周期估算)
2.2 项目计划 (项目团队,人员安排,时间安排,职责分工)
2.3 项目计划变更控制报告(可能会多份)
3
.
项目监控
3.1项目监控数据表
3.2项目偏差控制报告
3.3项目进展报告(应该定期提交该文档给上级主管,经理)
4
.
风险管理
4.1 风险检查表 (一份问卷调查表,定期由程序员,项目经理提交)
4.2风险管理报告 (一个文档对应一个可能的风险,以便跟踪)
5
.
需求管理
5.1需求跟踪报告 (这个文档应该是比较常见,对业务随时提出的需求,需要有文档对应,记录处理情况,有助于明确责任。在我们公司曾经就有业务人员打电话过来说,网页需要替换文字信息,我挂了电话,立马就发了封邮件告诉他,请你将要改动的文字发邮件过来,我要存档,因为,我要对网站的任何变动负责)
5.2需求变更控制报告 (对业务部门提出的需求要时刻准备他(她)们会推翻他(她)们原先提出的需求,不要觉得麻烦,你也会有犯错的时候)
6
.
系统设计
6.1体系结构设计报告 (系统概述,设计约束,设计策略,系统总体结构,子系统的结构与功能,开发环境的配置,运行环境的配置,测试环境的配置)
6.2用户界面设计报告 (应当遵循的界面设计规范,界面的关系图和工作流程图,主界面,子界面,美学设计,界面资源设计)
6.3 数据库设计报告 (这个文档的重要性,就不用我说了吧)
6.4 模块设计报告
7
.
实现与测试
7.1 实现与测试计划 (可以分为实现计划和测试计划两部分来写)
7.2 编程文档 (内似于程序员的编程日记,这个东西还是主要是程序员自己看的,良好的编码风格远比这重要)
8
.
系统测试
8.1 系统测试计划
8.2 测试用例 (确定测试用例,这个很技巧,不要随便的找几个测试数据)
8.3 测试报告 (这个文档还是交给业务部门或是专门的测试小组去完成,别让程序员自己测试程序)
9
.
客户验收
9.1 客户验收计划 (对于大的项目,其验收可以分模块进行,按RUP,增量的给客户提交可运行的系统,其验收计划也根据相应的开发方法来灵活定制,别相信某些书上的说的一些定论)
9.2 客户验收报告 (一定要强迫客户,也许他只是业务部门的同事,让他好好写验收报告,如果他们拒签,除非是你人际关系太差,那就是你们开发的东西真的没法见人)
10.
配置管理
10.1 配置管理计划 (人员及职责,配置管理软硬件资源,配置项计划,基线计划,配置库备份计划)
10.2 配置库管理报告 (实际上是记录代码备份,系统版本备份的相关信息报告)
11.
质量保证
11.1 质量保证计划 (内容应从需求分析产生的文档开始,到设计,编码,测试,验收都应用质量保证计划,其实也可以看成是测试计划的一部分,如果只是小项目)
11.2 质量保证检查表
11.3 质量保证报告
11.4 质量问题跟踪报告
12. 外包管理 (对一些特殊模块,可能需要专业开发商的产品)
12.1 外包开发竞标书
12.2 外包商评估报告
12.3 外包开发合同
12.4 外包开发过程监控报告 (这份文档可有可无,如果合作规定我方可获得外包商的源代码)
12.5 外包开发过程验收报告 (这个文档由业务人员和技术人员一起验收合写)
13.
培训管理
13.1 培训计划 (最终将会由业务,市场人员来使用系统,得为他们定制培训计划,和他们一起计划吧)
13.2 培训评估报告 (让他们对培训满意,不满意??再培训一次,一家人不说两家话嘛)
14.
维护
14.1产品维护计划
14.2 产品维护报告
15. 结项管理
15.1 结项申请书 (终于要完成了)
15.2 结项评审报告 (等报告下来了,和大家一起去吃顿好的,然后去唱K吧,记得叫上业务部的人,他们是用户)