软工文档总结

一、文档的重要性

文档的作用：

①提高软件开发的能件度。

②作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。

③提高开发效率。

④作为软件开发人员的一定成果和结束标志。

⑤便于以后的软件开发、使用和维护。

⑥便于管理人员、开发人员、操作人员、用户之间的协作。

⑦文档的过程就是软件开发的过程。文档是软件开发规范和指南。

二、文档的阶段

1.定义阶段

 （1）可行性研究报告

目的：在从技术、经济、管理和开发环境等几个方面，确定了一个软件可以完成，需求方和开发商共同讨论项目中的    开发方案。

预期读者：软件开发商、项目经理、分析员

 （2）需求分析说明书

目的：写出用户对软件的一些需求，明确软件的功能和性能，能够很清楚的指出开发人员需要做什么等。

预期读者：项目经理、开发人员、用户

 （3）数据要求说明书

目的：明确开发系统各项功能的实现时，对数据的要求，同时也为概要设计和详细设计阶段提供参考，为其他开发人员的阅读提供便利。

预期读者：项目经理、数据库设计人员、开发人员、维护人员、测试人员

 （4）用户手册

目的：为了使用户熟悉操作，给首次使用本软件的用户提供帮助，’ 使其能够尽快的掌握本系统的操作。

预期读者：购买了此软件的用户

 （5）项目开发计划

目的：对开发机房收费系统的费用、时间、进度、人员配置、开发环境和运行环境的配置进行说明，未开发的下一步做准备。

预期读者：项目经理、开发人员、分析员、用户

2.开发阶段

（1）数据库设计说明书

目的：根据数据要求说明书，数据库设计人员设计相应的数据库。

预期读者：项目经理、开发人员、数据库的设计人员

（2）概要设计说明书（设计软件的结构）

目的：在需求分析基础上得到的物理模型确定一个合理的软件系统的体系结构。包括：系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。

预期读者：项目经理、设计人员、开发人员、测试人员

（3）详细设计说明书（模块功能的具体描述）

目的：在概要设计说明书的基础上完成的，它更加仔细地清楚地描述模块中的内容，功能实现写的更加仔细。

预期读者：项目经理、开发人员、测试人员、维护人员等所有人员

（4）操作手册

目的：提供软件操作的步骤方法。

预期读者：用户

（5）测试计划

目的：找到系统中的漏洞，并且设计出测试用例

预期读者：项目经理、测试人员

（6）开发进度月表

目的：软件开发了一段时间之后，对进度的总结，及时发现在开发过程中存在的问题，为以后的开发提供经验教训，提高接下来项目的开发进度。

预期读者：项目经理、开发人员

（7）测试分析报告

目的：对测试数据功能问题进行分析归纳记录

预期读者：项目经理、开发人员

3.运行和维护阶段

（1）项目开发总结报告

目的：为以后项目的开发提供宝贵的经验，避免今后的项目中出现类似的问题，从而大大提高开发的效率。

预期读者：项目经理、开发人员

总结：

           这十三个文档中，在项目开发计划书、测试分析报告以及项目开发总结报告中，都最好加上甘特图，因为这样可以对原计划进度，以及在实际软件开发的过程中进度，形成一个对比。再就是项目经理的位置，他是一个掌握全局着，身上的责任很重，所以这些文档他都应该过目，确保每个阶段文档的正确性。