软件开发文档总结

  前言：      

       最近一个多星期都写在文档，刚开始写文档的时候简直是一头雾水，而且也觉得写文档是一个枯燥乏味的过程。如今已经把文档写完啦，也开始意识到了文档的重要性。下面谈一谈自己对文档的一些理解和看法。

是什么？

      软件开发文档是软件开发和维护过程中的必备资料。它能提高软件的开发效率，保证软件的质量，而且在软件的使用过程中有指导、帮助、解惑的作用。尤其是在维护阶段，文档更是不可缺少的资料。可以毫不夸张地说文档已经成为了软件的一部分。从某个意义上来说，文档比程序更重要。

分类：

      按照文档的使用范围和目标对象，将文档分为三类：开发文档、管理文档、产品文档。

                    

       按照软件工程的开发阶段进行分类，即定义阶段、开发阶段、运维阶段、如下图

                                 

对每一个文档的理解：

（1）可行性研究报告：

       说明在项目进行前，对项目从经济可行性、技术可行性、社会环境可行性等几个方面确定该项目公司是否要接手。阐述为了达到开发目标，所采用的各种可行性方案。以及论证所选方案的理由。

（2）项目开发计划：

       此项目开发计划的编写主要是为了给开发系统做主要的规划和整合，在开发过程中起引导的作用，以及为软件使用人员的使用提供一些简单的声明。项目开发计划应交给管理部门，作为开发阶段评审的参考。

（3）软件需求说明书：（软件规格说明书）

       软件需求说明书是用户与开发人员双发在对软件需求，取得一致性理解的基础上，对目标软件的功能、性能用户界面以及运行环境等做出详细的说明。还能够在一定程度上，控制系统进化过程。在需求分析完成后，如果用户追加需求，那么需求规格说明书将用于确定追加需求是否为新需求。如果是，开发人员必须针对新需求进行需求分析，扩充需求规格说明书，进行软件再设计。

（4）数据要求说明书：

       明确需采集数据的信息系统，数据采集的范围和方法，为生成和维护系统数据文卷做好准备。

（5）数据库设计说明书：

        明确系统的物理结构和数据结构，用于开发人员进行项目设计。同时也为之后的数据库维护提供了一个很好的说明书，是数据库进行维护的重要材料。

（6）概要设计说明书：

        说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据库设计和出错处理设计等，是概要设计的主要成果。为后续进一步的详细设计做好准备。

（7）详细设计说明书：

        着重描述每一模块是怎么实现的，包括逻辑结构、流程结构以及算法等。以求开发者高效得完成该系统。

（8）用户手册和操作手册：

         为用户提供帮助，让用户了解系统的功能、如何使用、以及如果解决软件使用过程中出现的一些小问题等情况。通过本文档的学习让用户能够快速全面的掌握本软件的使用方法。     

（9）测试计划：

         根据测试计划报告，对软件进行测试，为测试提供各种测试方案。并记录详细的测试过程，以便于快速高效得查找出项目中的bug。

（10）测试分析报告：

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

（11）开发进度月表：

        该报告是软件开发人员按月向管理部门提交项目进度情况的报告，让管理人员对开发人员的项目进度能够有一个大概的了解，以便更好的完成开发工作。报告中应该包括进度计划以及实际的执行情况。阶段性成果，遇到的问题，以及是如何解决的等。

（12）项目开发总结报告：

        软件项目开发阶段完成后，应该把实际开发情况与项目开发计划做一个对比。总结实际执行情况并对开发工作进行评价，指出开发此项目的经验和获得的教训。

各个文档的读者：

        不同的文档是为不同的人员而书写的。下图中将展示各个文档的预期读者。

        

总结：

        文档是软件开发和运维阶段必备的宝典，是软件开发过程中不可或缺的一部分。第一次写文档真的是无从下手，一头雾水，但是硬着头皮去做，写过一般之后，回过头来再看看。发现原来不太懂的东西似乎有写懂了。学习就是一个过程需要不断的去重复，重复就是力量！