第一次机房收费文档总结

前言       

            软工文档是在看完软工视频并且结合之前做过的机房收费系统编写的，这次文档主要是针对机房收费系统编写。文档是系统开发建设的生命线，它贯穿于管理信息系统开发的整个过程，系统开发的各个层次和阶段都要有相应的文档，很重要。主要包括可行性研究报告、项目开发计划、软件需求说明、概要设计说明书、详细设计说明书、数据库设计说明书、数据要求说明书、测试计划、测试分析报告、项目开发总结报告、操作手册、用户手册和开发进度月报。

        初次接触文档，看到这么多文档的时候一下子就晕了，这该如何下手？虽然有文档的格式，但是还是不会写，根本不知道要怎么写，还担心写的不好，然后就在文档这里停留了好几天 。这几天正好开师徒会，就跟师傅说了这个问题，然后师傅说，没有什么会不会，只要去做就好了，当你沉下心去做一件事情的时候你的感觉会不一样。开完师徒会之后还是很抵触这个文档，作为初学者，编写文档真的很痛苦，不过看看别人的博客，自己琢磨着就开始了。万事开头难，很快就写完了，虽然第一次写的不是很好，但还是写完了，了解了主要的功能，以及各个文档都是给谁看的等等。下面是对文档的总结。

软件生存期及相关文档

            可行性研究阶段涉及的文档主要是《可行性研究报告》和《项目开发计划》，这个阶段的文档所发挥到的作用就是从经济、技术、法律等各方面确定这个系统是否值得开发，从而确定系统的目标、规模和基本任务。读者：相关领导、项目负责人

       需求分析阶段涉及的文档是《软件需求说明书》，目的主要是确定系统具备什么样的功能，深入描述软件的功能和性能以及软件的约束范围，使用户和软件开发者对该软件的初始规定有个大概了解。读者：开发人员、用户

       设计及编码阶段涉及的文档时《概要设计说明书》、《详细设计说明书》、《数据库设计说明书》和《数据要求说明书》，

       《概要设计说明书》的目的主要是确定在用户的需求分析阶段的基础上，对机房收费系统做概要设计，为在需求分析阶段得到的目标系统的物理模型确定一个合理的软件系统的体系结构。包括合理地划分组成系统的模块、模块间的调用关系及模块间的接口，并且为软件系统提供所用的数据结构或者数据库结构。读者：软件开发人员

       《数据库设计说明书》提供了数据库设计的可视性以及软件支持所需的信息。读者：开发人员

       《数据要求说明书》明确了相关输入输出数据以及软件内部的数据，明确软件各项功能和非功能性需求实现时所需要的数据。读者：软件开发人员、软件测试人员

       测试阶段涉及到的文档有《测试计划》和《测试分析报告》。

       《测试计划》是为了找出系统的漏洞，找出系统存在的问题，尽可能多的发现系统中没有出现的问题，方便以后系统正常运行，减少错误的产生。读者：软件开发人员、软件测试人员、软件维护人员

       《测试分析报告》是通过各种类型的测试，查出软件设计中的错误并改正，确保软件质量。读者：软件开发人员、软件维护人员。

       运行和维护阶段涉及到的文档《操作手册》和《项目开发报告》

       《操作手册》告诉用户该系统提供了哪些功能，以及如何正确地、有效地来使用这些功能。读者：用户

       《项目开发报告》是为以后的开发提供依据，避免发生相似的错误，提高我们的开发效率，读者：项目开发人员、项目经理