软工文档

     文档最主要的目的还是为了做好软件的开发，协调好客户和相关开发人员关系，做出高质量并符合客户需求的软件产品来。机房收费系统只是代码的一小部分，标准化、完整、流程化的文档才能更好的完成软件开发工作。

   1.有了文档犹如规定了流程似的，各部门能够各尽其职，有条不絮的进行，提高效率。

   2.每个文档都是阶段性的里程碑，是对一定阶段的工作成果的检验和认可。

   3.在软件的开发过程中记录一定的工作信息，为以后的软件开发、使用、和维护具有借鉴意义。

   4.能够方便跟人员之间的交流、沟通，利于软件开发更合理、更有效的满足用户的需求，能够及时沟通，避免      误解，减少不必要的隔阂。

   5.好的文档计划能够让更多的潜在用户了解软件的功能、性能等更方面的性能，为用户的需求选择提供参考。

      

   以下是各文档的具体描述：

   1.可行性报告
     研究在技术、经济、社会上的因素，评述为合理的达到开发目的的各种可行方案，说明、并论证实施方案

  2.项目开发计划
    制定具体的计划，（工作人员、开发进度、经费的概算、硬件、软件资源、）做完之后提供给管理部门。

  3.软件需求说明书
    对开发软件的功能、用户界面、性能以及运行环境做出详细的说明，是用户和开发人员之间对软件需求共同     认可之上达成共识，是实施开发工作的基础。

  4.数据要求说明书
   给出数据逻辑描述和数据采集的各项要求，为生成和维护系统的数据文件做好准备。
 
  5.概要设计说明书
    属于工作阶段的成果，系统的功能分配、模块的划分、程序的总体结构、输入输出及接口设计、运行设计、数据结构设计、出错处理设计等为详细设计奠定基础

  6.详细设计说明书
    描述每一个模块是如何实现，包括实现算法、逻辑流程等

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

  8.操作手册
    为操作人员提供软件各种运行情况的有关知识，特别是操作方法细节。

  9.测试计划
    针对集成测试和确认测试，需要为组织制定计划。测试的内容、进度安排、条件、人员、
测试用例的选取原则、测试结果允许的偏差范围等。

  10.测试分析报告
      测试工作完成后，应该提交测试计划的执行情况的说明。对测试结果加以分析，并提出测试的结论性意见。

  11.开发进度的月报
      是软件开发人员按月向管理部门提交的项目进展情况的报告。其中包括计划进度和实际执行情况的对比、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

  12.项目开发总结报告 
      开发完成之后，应当与项目实施计划对照，总结实际执行的情况，进度、成果、资源利用、成本和投入的人力，还需对开发工作做出评价，总结经验和教训。

        软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供给管理人员， 并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度、资源使用和成果等。软件开发人员需为用户了解软件的使用、操作和维护提供详细的资料，我们称此为用户文档。以上三种文档构成了软件文档的主要部分。

   文档在软件开发中就是个桥梁，是沟通用户、软件开发人员和软件管理人员的桥梁。软件开发人员在开发过程中把文档作为软件开发的前一阶段的总结以及后一阶段的依据。软件开发过程中，软件开发人员会制定一些软件开发计划或者工作报告，这些计划或报告都要提供给管理人员得到必要的支持，这就是开发文档。而软件管理人员则可以根据这些文档了解软件开发的安排、进度、使用资源和成果；管理人员也要在宏观上把握和控制软件开发的整体进程，与这些相关的就是管理文档了。此外，软件开发人员需要为用户了解、使用、维护软件提供详细的资料，这就是用户文档了。当然，各个文档并不是独立的，它们之间是有一定联系的，共同促进开发工作的进行