机房收费系统是我们进入提高班后唯一一个勉强算是自己独立完成的任务,后来的重构机房收费系统需要写完整的文档,针对于机房收费系统文档的编写,我做了如下的总结:
文档的组成
一:可行性研究报告:
1 给予本项目一个开完成的书面证明,预测问题,寻找措施!
二:项目开发计划:
1 目的:为了让项目按计划的顺利进行。
面向项目工作人员:开发人员、需求分析人员、测试人员。
三:软件需求说明书
1 目的:保证软件开发的质量、需求的完整性和可追溯性;同时通过本文档能让客户、软件开发人员、需求分析人员、测试人员以及其他相关人员达成一个共识。
面向客户、需求分析人员、测试人员、软件开发人员等。
四:概要设计说明书
1 目的:
明确任务和需求 使得
软件开发
人员知道软件开发流程,
软件
测试时更有条理
面向软件开发人员和测试人员
五 详细设计说明书
1 目的:
指出各功能模块的具体设计,便于开发人员进行开发!
面向开发人员,功能模块的具体设计。
六:数据需求说明书
1 目的:为系统功能和非功能性需求提供所需的数据,作为设计数据库的基础,同时也是概要设计和详细设计的数据依据。
面向开发人员、测试人员、数据库管理人员。需求分析人员提出所需数据。
七:测试计划
1 目的:
为了通过测试对软件进行评价而规定的一个计划,方便测试的运行。
八 :测试分析报告
1 目的:对测试结果和数据进行分析总结,对以后软件的更新和软件开发人员阅读源程序提供了便利。
九:项目开发总结报告
1 目的:总结之前各个阶段的问题和经验。
十:操作手册
1 目的:用户对本系统的应用指导,便于用户了解本系统
面向开发人员和用户。
十一:用户手册
1 目的:便用用户正确使用本系统。
面向用户。
我写文档出现的问题:
这部分主要是由我师傅通过一份邮件提出来的,让我去改所以给大家看一下我师傅给我提出的问题:
然后我照着师傅的提出的一些问题,然后补足了自己的不足,尤其是UML图的不足,以及不知道把图放到那里的问题,感谢师傅们的指导与教诲。
我自己的收获
通过这次对文档的编写与修改完善,我才知道自己之前写文档的任性。第一次写文档大部分都不是自己的东西,所以不知道UML图的放在那里,也不知道文档的编写步骤。自己这次的完善不仅让我对文档的重要性有了认识同时也让我看到了自己学习上的一些不足。这次画UML图接触了新的软件工具EA,看同学们博客里面所说的EA的功能确实强大,感谢你们让我懂了这些!希望与大家多多交流!