从机房收费系统看文档编写

     机房收费系统的文档编写已经完成了一段时间了，零零散散的总结过一些了，这次从整体上概括总结一些写文档的收获。

     在看过软工视频后，体会到软件工程是软件设计的灵魂，是我们前进的指导思想。贯穿其中的便是文档了，视频中各个阶段都对文档进行了详解。但是只看不实践，总是觉得那样懵懂。机房收费系统的文档总结就是我们实践的机会。通过编写，会对软件工程加深理解吧。第一次写，大概都有一些迷茫吧，但是跟着模板，大胆往下写，不管好与不好，写了，就学到了！

     验收项目的时候听到师父说出去实习的师哥师姐工作地点的软件开发人员在开发之前不会去编写文档，代码也都不写注释，就算写注释了可能也都是错误的。听了这个确实感觉提高班出去的确实不同于他人，我们拥有着软件开发人员的基本素质。在这里就强调先强调一下文档及其重要性。

      什么是文档？

      文档是软件开发使用和维护中的必备资料。
     软件文档或者源代码文档是指与软件系统及其软件工程过程有关联的文本实体。文档的类型包括软件需求文档，设计文档，测试文档，用户手册等。其中的需求文档，设计文档和测试文档一般是在软件开发过程中由开发者写就的，而用户手册等非过程类文档是由专门的非技术类写作人员写就的。

      文档的作用及其重要性有哪些？

      1.软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，提高软件开发过程的能见度。将软件开发过程及软件的功能以文本的方式体现方便阅读。
      2.软件开发过程中软件开发人员需制定一些工作计划或工作报告，并提供给管理人员， 管理人员则可通过这些文档了解软件开发项 目安排、进度、资源使用和成果等，实现了对软件工程的管理。
      3.文档能提高软件开发的效率，保证软件的质量，而且在软件的使用过程中有指导、帮助、解惑的作用，尤其在维护工作中，文档是不可或缺的资料

      4.提供对软件的运行维护培训等相关的信息，便于管理人员、开发人员、设计人员和用户等之间的交流协作，使软件开发更灵活有效。

     各阶段文档的主要内容是什么？

    1. 可行性研究报告：就是说明该软件在经济技术和社会法律等因素上是否可行。

     2.项目开发计划：从相关人员安排，进度安排及开发经费的预算等方面对项目实施方案制定出具体的计划。

     3.软件需求说明书：对软件的功能性能用户界面还有运行环境等作出详细的说明，是用户和开发人员交流的桥梁。

     4.数据要求说明书：给出数据逻辑描述和数据采集的各项要求。

     5.概要设计说明书：概括性的说明软件的功能分配，模块划分，程序的总体结构，输入输出及接口设备等等等等，为详细设计奠定基础。

     6.详细设计说明书：在概要设计说明书的基础上详细的描述每个模块是如何实现的。

     7. 用户手册：详细描述软件功能性能和用户界面，使用户了解如何使用。

     8.操作手册：为操作人员提供软件各种运行情况的有关知识。

     9. 测试计划：制定测试计划，测试内容需在设计的错误范围内。

   10.测试分析报告：测试完成后，提交相应说明后对结果进行分析，并提出相关 意见。

   11.开发进度月报：对项目进展情况进行报告，应包括进度计划和实际执行的一些比较。

   12.项目开发总结报告：软件项目开发完成之后，总结实际执行的情况和计划情况的对比差异，并作出评价。

   13.软件维护：投入运行后，若有修改更正，应对相应问题做详细描述，并写好维护建议。

      希望通过这次文档的编写，能够充分认识到文档的重要性，在以后的开发过程中，做一名合格的软件设计师。