软件项目管理下该写的文档

发布时间:2016-12-11 6:42:12 编辑:www.fx114.net 分享查询网我要评论
本篇文章主要介绍了"软件项目管理下该写的文档",主要涉及到软件项目管理下该写的文档方面的内容,对于软件项目管理下该写的文档感兴趣的同学可以参考一下。

    要想保证一个软件项目的成功,文档比不可少,不要相信那些XP不用写文档的鬼话!不写文档不管是开发还是后期的维护,都会非常的麻烦! 我总结一个良好的软件项目应该产生如下文档,我采用目录树的形式来表示这些内容: 01 ××项目 |_______01 项目管理                 |__________01 管理文档                                          |_________01 立项                                          |_________02 计划                                          |_________03 监控                                          |_________04 结项                 |__________02 开发文档                                          |_________01 开发规范                                          |_________02 需求分析文档                                          |_________03 设计文档                                          |_________04 界面图                                          |_________05 UML图                                          |_________06 数据字典                                          |_________07 测试文档                 |__________03 产品文档                                          |_________01 产品手册                                          |_________02 用户指南 大的文档有三类:管理文档、开发文档、产品文档 管理文档是指涉及到整个项目管理的文档,包括立项、计划、监控、结项。 这些管理文档是对整个项目起指导意义的。比如说,计划中就可以包括项目的进度计划,人员的培训计划等,监控可以包括在项目的开发过程中需要进行监控的点,对这些监控的点的评测结果以及调整方法,还包括对项目进行评审的文档。 开发文档是在整个项目开发过程中产生的文档。 1、首先需要建立需求分析文档,这个文档很重要,项目经理或者模块负责人负责撰写,采用文字描述即可。主要内容为该模块需要实现的功能的整体性分析,不要写的过于详细。2、然后在需求分析文档的基础上建立该模块的设计文档。项目经理或者模块负责人撰写。具体写该模块每个窗体需要实现的功能。在这个文档中需要包含“界面图”,“UML图”,“数据字典”的超级链接。“界面图”需要超级连接图的内容,“UML图”与“数据字典”则仅仅超级链接文档即可。3、界面图采用VISIO来画,只要画出该模块下每个窗体的界面即可。4、UML图包括具体的用例图,顺序图,类图等,还需要定义业务接口。5、数据字典采用POWERDESIGN来设计,用来描述具体的表与字段的作用。6、在以上文档有了之后,程序员就可以根据设计文档的描述开始进行编写具体代码的工作了。7、编写过程中需要及时的进行测试,包括单元测试与自动测试。测试文档中写自动测试的结果即可。8、如果任何步骤需要变化,需要及时调整文档。保证代码与文档同步。虽然工作量增大,但是必须做。 需求分析文档相当于 项目建议书,这个文档是开发者与用户之间沟通的一个桥梁。用户还可以看 设计文档中的 界面图、UML图里的用例图与顺序图。设计文档相当于 总体规格书,设计文档是程序员工作的基础,也是测试人员进行测试工作的基础。 而这些的一个前提是需要有一个好的系统架构。 产品文档是指整个项目完成后需要给用户交付的文档。 产品文档也并不是非要等全部项目完成才写,如果开发完了一个,并且比较稳定后,就可以撰写。一般包括产品手册与用户指南。格式可以是HTML,比较灵活而且图文并茂还可以直接制作Flash的教程,更直接! 只有有了这些文档之后,你的项目的整个开发过程才能有保证,有了这些还不能保证你的项目一定成功,要注意及时的根据需要来更新这些文档才行!!!

上一篇:哲学小故事68篇
下一篇:

相关文章

相关评论