软件文档也称文件，通常指的是一些记录的数据和数据媒体。文档对软件开发的各个阶段有很大的作用。高效率地开发、分发、管理和维护文档对于开发软件产品有着重要意义。

      文档在软件开发人员、软件管理人员、维护人员、用户以及计算机之间进行交流的桥梁。软件开发人员在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据。软件开发人员需制定一些工作计划或工作报告，这些计划和报告都要提供个管理人员，并得到必要的支持。管理人员则可通过这些文档了解软件开发项目安排、进度。资源使用和成果等。软件开发人员需为用户了解 软件的使用、操作和维护提供详细的资料。根据文档面向的读者的不同，文档可以分为3类，既开发文档、管理文档和用户文档。

         1、可行性分析报告：论述待开发软件的实现在技术上、经济上、管理上和开发环境的可行性，判断该公司是否有能力对用户提出的软件进行开发。

         2、软件需求说明书：对用户提出的软件需求进行整理，对待开发软件的功能、性能、用户界面及运行环境做出详细的说明。软件需求说明书是开发人员和用户进行交流的保证，也是后期进行软件开发的依据。

         3、项目开发计划：制定项目开发计划书，对开发工程中各个阶段的负责人、开发进度、所需经费预算、所需软、硬件设备等做一个初步的计划，以便根据本计划更好地进行开发。

         4、数据库设计文档：该文档是对软件运行所需的数据库进行设计，内容大致有三部分：概念设计、逻辑设计和物理设计。

         5、概要设计说明书：该文档是概要设计阶段的成果，它应说明待开发软件的功能分配、模块划分、程序流程设计、输入输出设计、接口设计和错误处理等，为详细设计奠定基础。

         6、详细设计说明书：该文档是着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

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

         8、操作手册：为操作人员（用户）提供该软件各种运行情况的有关信息，重点是操作方法的具体细节。

         9、测试计划：为更高效地对开发出的新系统进行测试，需制定测试计划。计划应包括测试的内容、进度、条件、人员、测试用例、测试结果允许的误差等。

         10、测试报告：测试工作完成后，测试人员会编写一份测试分析报告，用与对测试做总结。

         11、开发月度报告：该报告用于向上级反映项目开发进度，报告中包括进度计划于实际执行情况的比较、阶段成果、遇到的问题与解决方法以及下个月的进度安排。

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

         13、维护修改建议：产品投入运行后，发现了需对其进行修正、更改的问题，应将这些问题及其修改的建议，写成维护修改建议，提交审批。

          以上讲述了各个文档完成的任务，那么这些文档在软件开发过程中的位置如何呢？

        另外，软工文档里还应加入UML的9种图，UML图在文档中没有固定的位置。在需求分析阶段主要是面向用户，用用例图和类图扩充其文档；软件设计阶段主要是面向开发人员的，用类图、时序图/协作图、活动图/状态图扩充其文档，其他阶段文档可根据实际情况，灵活变动，将UML图填充其中。

总结

软件工程之文档