软件工程之相关文档

经过长达10天左右的时间，软件工程文档基本完成，只差师傅验收了，虽然这个期间，一直都是借鉴的好多人的文档以及从网上找对各个文档的相关理解，但终究还是有自己的收获的。

说起来感觉比较羡慕的是，在网上查相关文档的时候，第一条永远都是那一个人的。感觉被所有人承认，那肯定非常的了不起。

 软件工程是一个整体的，组织全面的工程，需要有配套的完整方案实行，这就需要文档来解决。

文档，就是在软件工程开发过程中每个阶段需要的实行依据。比如建立初期，需要有研究报告；开发时需要开发计划；设计中需要有软件需求、详细设计、数据库设计说明书等相关文档；而在设计完成后，就需要测试了，测试之前要有测试计划，测试过程中需要有测试记录，测试完成也要有测试分析报告；项目研究成功，可以投入使用时，也要有总结报告、操作手册和用户手册；还有一个就是在各个阶段都需要有的开发进度月报（或者周报也可以）。

 文档，不仅仅提供的是软件工程开发依据，还是以后修改和维护的重要依据，也是文档初级编写者学习的依据。随着每次写文档，看着以前的文档都会有不同的感受，感觉这里不好，可以修改，感觉那里不好，也可以修改，久而久之，文档会写的越来越好。

 

下面就介绍各个文档的主要内容：

 1.可行性研究报告

目的是在某个方面的进步性；评述为了合理地达到开发目标而可能选择的各种方案等等。

在开始一个项目时，需要完成可行性研究报告，研究此开发项目是否能够完成，解理由。例如分析软件的投资和收益可行性、技术可行性、人员可行性、其他影响，开发软件的要求等等。

 2.项目开发计划

主要是为了给开发项目做整体的规划，在开发过程中起引导作用，并给项目开发和设计者提供简单说明，例如项目概述、实施计划、支持条件和专题计划（如分合同计划、开发人员培训计划、测试计划、安全保密计划、质量保证计划、配置管理计划、用户培训计划、系统安装计划等）要点

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

3.软件需求说明书

    本文档的目的：就是对软件应该具备什么功能、性能和运行环境的规定

1.方便用户、分析人员和软件设计人员进行理解和交流。用户通过需求规格说明书在分析阶段即可初步判定目标软件能否满足其原来的期望，但是本文档主要是作为设计人员的软件开发的基本出发点和系统维护人员发现和添加新功能需求的基础，也是维护人员的技术支持文档之一。

2.支持目标系统的确认。软件开发目标是否完成不应由系统测试阶段的人为因素决定，而应根据需求规格说明书确立的可测试标准决定。

3.控制系统进化过程。在需求分析完成后，如果用户追加需求，那么需求规格说明书将用于确定追加需求是否为新需求。如果是，开发人员必须针对新需求进行需求分析，扩充需求规格说明书，进行软件再设计。

4.详细设计说明书

本文档的编写为了系统软件的开发途径和应用方法，以求开发者在最短的时间高效的开发并完成该系统。对项目所有程序分别进行详细的设计，如功能、性能、输入和输出、算法、流程、接口、存储、限制、测试、问题等的设计说明。

5.数据库设计说明书

软件工程一般离不开数据，因而数据库的设计也很有必要。而本文档就是对描述数据库设计、结构情况，用于开发人员进行项目设计，同时也为后续的数据库维护工作提供了良好的使用说明。

6.测试计划

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

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

测试计划需要对分别对某项程序或功能做详细计划。

7.测试分析报告

根据测试计划进行各种测试，记录测试结果，并详细的将测试结果详细的解释清楚。

8.项目开发总结报告

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

9.操作手册和用户手册

目的是为了给用户提供帮助，对于没有接触过本系统的用户能够学会使用本系统。通过本文档，能够让用户熟练使用本系统。就像平常生活中的各种说明书，虽然我们没哟接触过某一个商品，但是通过使用说明书可以在最短的时间内掌握，并灵活运用。

10.开发进度月报

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

 

曾看多过这样一句话“ 软件工程是编程的基础，文档就是程序员的助手，文档至关重要。”做好文档，我们可以高效率地完成某个软件工程，也可以有更充足的时间学习其他知识或休息。