详解软件工程之软工文档（总结篇）

最近的半个月的时间一直在写软件工程的文档，软件工程的文档也总算接近尾声了，下面我谈一谈对软工文档的简单的理解。

在开始写软工的文档时，不知道软工的文档不是干嘛用的，总之是一头雾水。文档快结束时，才体会到文档的重要性。

 

一、对文档重要性的理解

 

文档的作用其实是很多，不仅仅只是为用户、程序员提供一个可靠的依据。无论是对于用户还是对于程序员都做到有据可寻，编程结束之后如果出现什么差错，检查这是谁的问题，当然就得根据文档，文档就相当于法律条文，明确规定各自的任务，不符合用户的需求就是程序员的问题，这样公司就会遭受损失。

为系统的维护，提供最有利的技术支撑，相信大家都知道，做系统非常的容易，后期的维护工作才是一个优秀的编程团队需要考虑的问题。

 

二、各个文档的目的

 

对于每个文档的目的深刻的理解，编程只是再简单不过的小菜。

1. 可行性研究报告

说明该软件开发项目目的是在在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能选择的各种方案等等。

在开始一个项目时，需要完成可行性研究报告，研究此开发项目是否能够完成，解释理由。

1. 项目开发计划

此项目开发计划的编写主要是为了给开发系统做主要的规划和整合，在开发过程中起到引导作用，以及给在使用者提供简单的说明。

项目开发计划是为项目组长查看，此项目的开发计划以及多长时间可以完成，是查工作进度最直接的证据。

1. 软件需求说明书

本文档的目的

1. 方便用户、分析人员和软件设计人员进行理解和交流。用户通过需求规格说明书在分析阶段即可初步判定目标软件能否满足其原来的期望，但是本文档主要是作为设计人员的软件开发的基本出发点和系统维护人员发现和添加新功能需求的基础，也是维护人员的技术支持文档之一。
2. 支持目标系统的确认。软件开发目标是否完成不应由系统测试阶段的人为因素决定，而应根据需求规格说明书确立的可测试标准决定。
3. 控制系统进化过程。在需求分析完成后，如果用户追加需求，那么需求规格说明书将用于确定追加需求是否为新需求。如果是，开发人员必须针对新需求进行需求分析，扩充需求规格说明书，进行软件再设计。

1. 详细设计说明书

本文档的编写为了系统软件的开发途径和应用方法，以求开发者在最短的时间高效的开发并完成该系统。

1. 数据库设计说明书

本说明书说明项目的数据库设计、结构情况，用于开发人员进行项目设计，同时也为后续的数据库维护工作提供了良好的使用说明，也可以作为未来版本升级的重要资料。

数据库是一个项目中最重要的部分，如果数据库出现各种各样的问题，编写的软件再好也可能成为废品，没有数据库作为支持，编写的任何代码都没有用武之地。

1. 测试计划

根据测试计划报告，对软件进行测试，详细记录测试过程，以对软件的食量进行评价，对软件设计人员提供BUG依据。

测试计划是在项目开发的过程中制定的，为测试提供各种测试方案，可以方便更加查找项目中的BUG。

1. 测试分析报告

为了发现软件更多的错误，根据测试计划进行各种测试，并详细的将测试结果详细的解释清楚。

1. 项目开发总结报告

为了总结本项目开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价，说明本项目的工作流程，工程开发中状况，最终结果，经验教训等。

1. 操作手册和用户手册

目的是为了给用户提供帮助，对于没有接触过本系统的用户能够学会使用本系统。通过本文档，能够让用户熟练使用本系统。

操作手册和用户手册是给用户看的，最简单的目的就是让未使用过此系统用户看到这个文档时能够在最短的时间内，可以高效的使用本系统。就像平常生活中的各种说明书，虽然我们没哟接触过某一个商品，但是通过使用说明书可以在最短的时间内掌握，并灵活运用。

1. 开发进度月报

为项目组长掌握开发进度提供最可靠的依据，高效的完成软件的开发，并为项目的开发总结报告提供各项依据。

 

三总结

 

软件工程是编程的基础，文档就是程序员的助手，文档至关重要。

 

软件工程的学习是很简单的，希望我的分享对您有帮助，并希望大家提供宝贵的建议。

详解软件工程之第一要务需求分析

详解软件工程之学习方法

详解软件工程之软件测试

详解软件工程之软工文档（总结篇）