软件工程之软工文档总结

刚开始写文文档的时候不知道怎么写，也不知道写它有什么用，也没有太深的了解，所以就站在巨人的肩膀上，看看别人是怎么写的，边看边抄，就这样写了一两个过去才知道了文档的重要性，我自己感觉做第一次机房收费系统的时候就是在实践，而写的文档就是理论，指导我们开发软件的手册。

在做机房系统的时候我们没有考虑到那么多的知识，只知道把这个系统做出来，实现所预期的功能，满足用户需求就行，随然说满足用户需求，可是说实话到底怎样才会满足用户需求在我自己心里也没有个底，机房收费系统做到什么样的程度也没有个具体的概念。在写完了文档才发现在实践系统的时候需要考虑的知识太多了，不仅仅是系统能实现自己所预期的功能就行了，

整个项目从分析，设计，实现，交付用户使用有太多的步骤了，还有进行后期的维护，人员的培训等。

一、步骤

二、各个阶段文档的目的

1.可行性研究

就是对整个项目的分析，分析它的可行性，在分析它的可行性的时候要需求分析、市场调查、在开发过程中会遇到的困难、解决办法、还有技术人员，物力，财力、所应用的环境等。通过分析各方面的因素进行权衡开发的可行性，在不违犯法律的前提下以最低的成本获取最高利润。

2.项目开发计划

确定了项目开发，就进行对系统预算，包括它的经费，需要的人力，物力，开始时间，结束时间等等。分析软件支持的软件和硬件配置，在编码中所需要的数据，数据库，数据结构，验收标准，参考资料的备用等。

3.软件需求说明书

分析软件所要求的功能，性能，调查用户的使用习惯，爱好，知识能力等，分析设计出来的软件怎样才能满足用户的使用习惯，用户是那些人，每个人的权限问题。假如交付使用，在使用过程中出现故障该怎么办，为了用户的利益，要提供后期进行维护的原则。

4.概要设计说明

将各个阶段划分开来，确定人机界面和接口，还有数据库的设计，数据库的结构特性，数据库的输入，输出。完成整个数据库的设计，需求分析，总体设计，逻辑设计，流程分析以及一些命名规范等等。

5.详细设计说明书

详细设计对我们设计过程中的每个步骤细化，使每个步骤更精确化，对每个模块的要求，每个模块所实现的功能，还有性能，让程序员设计的时候有更多的参考，使整个软件设计出来精确，提高开发效率。

6.数据库设计说明书

（1）这个文档的设计主要是为了让数据库的设计者和数据库管理员提供参考，为数据库的设计指引方向，也可供其他设计者参考。

（2）主要是描述数据的逻辑和数据的采集范围，对数据的输入，输出进行一些描述还有对数据的约束，控制数据库在可行的范围之内，符合现实生活，包括一些数据类型，各输入输出设备。

7.测试计划

制定测试方案，以及测试数据，测试的目的是检验系统的状态，检验系统在运行过程能不能实现设计人员的设计思路，能不能实现所要求的功能，通过测试达到用户的要求，不行的地方进行修改，保证系统的完整性，一致性，符合用户要求，能按时交付使用。

8.测试分析报告

在测试分析的基础上，把需要改进的地方，以及检验报告，结果等数据记录下来，对系统不满足的地方进行分析，制定相应的措施。

9.项目开发总结

在编写此文档的时候，系统基本已经完成，此时需要做的就是对整个项目进行全面的分析，找出在开发过程中的优点和缺点。和预定的计划做对比，进步是否按设定的时间完成，经费有没有超出估算的范围，设计人员的技术是否支撑起来了软件的开发，功能，性能是否实现，满足用户的需求。

10.操作手册

其实操作手册只是整个项目使用手册的一部分，操作手册是对整个系统进行怎样操作，以及本系统提供了那些功能，如何正确地，有效的使用，需要注意的一些事项进行了阐述。

11.用户手册

用户手册相对于操作手册就范围大了，用户手册为用户提供了一个使用指南，在操作手册的基础上还包括了对于遇到问题如何解决以及系统的一些设计原则，范围，还有后期对系统的维护等事项。

12.开发进度月报

对本月的开发进度和消耗经费，支出情况以及不足分析，制定改进措施，在下月的开发做个计划，提高开发效率。

三、各个文档的预期读者

1、可行性研究报告：系统管理人员、开发人员、维护人员

2、软件开发计划：用户、开发者、管理者、分析人员

3、软件需求说明书：系统开发人员、用户、系统测试人员

4、概要设计说明书：系统管理人员、开发人员、维护人员

5、详细设计说明书：项目设计者和程序员

6（1）数据库设计说明书：数据库设计师、数据库管理员

  （2）数据要求说明书：数据库设计人员、系统测试人员

7、测试计划：测试人员

8、测试分析报告：软件开发人员

9、项目开发总结报告：项目开发人员

10、操作手册：机房收费系统的用户

11、用户手册：机房收费系统的用户

后记

在写完文档之后对系统开发有了进一步的认识，知道在开发中需要注意的事项并不仅仅是自己想象的哪一点，自己知道的只是九牛一毛，还有更多的需要探索，需要学习，还有很大的进步空间。