软工文档总结学习篇

文档的编写既不是空穴来风，也不是一劳永逸的，每编写一份文档我们都是有目的的，面向一定的对象的，那么这软工的十二个文档具体内容肯定是不同的，那么我们可以抓住的相同点是什么呢，如何令我们自己对文档的理解四两拨千斤呢 ？LET'T GO！！！

    WHY

即这些文档编写的目的是什么
    可行性研究报告：简单的来说就是这项工程到底有没有必要性或者顺利实现的可能性
                    这样我们就可以避免在工程进行中对突发状况（技术、资金、人员
                    等）的手足无措
                    书面一点便是，是检验需求的一部分，是项目建设论证、审查、决
                    策的重要依据，也是以后筹集资金的一个重要依据
                    通过对技术、经济社会等的分析进行分析及预测日后的经济效益
                    对接下来其他工作的进行也起到一个规范作用
     项目开发计划： 不谋万世不足谋一时 不谋全局不足谋一域，基本就可以概括为什么
                    要进行项目开发计划
                    具体一点可以是，保证系统开发过程中的开发工作者的有序进行，
                    避免不必要的人力、物力、资源、财力的浪费
                    协调子系统间的工作
                    保证系统开发过程中的信息共享
                    接下来各种工作的总指挥棒
     软件需求说明书：主要是为了准确的确定用户的需求。
                     其次可以作为软件开发工作的基础和依据，和确认测试和验收的依
                     据
                     也可以软件需求具体细化，如为了达到客户的需求，软件的开发过
                     程应达到什么需求（接口、性能的要求）
     概要设计说明书：主要是说明对程序系统的设计考虑，把骨骼和皮肤弄成什么样子的
                     如流程的基本处理，系统的组织结构、模块的划分、功能分配、接
                     口设计、运行以及出错处理设计等
                     为详细设计奠定了基础
     详细设计说明书：概要设计的基础上进一步明确系统结构，详细地介绍系统的各个模
                     块，即每一个模块的进一步剖析设计
     数据库设计说明书：为了向这个软件的开发后期提供后台数据库的设计，既可以当做
                     验收时是否符合数据存储要求的一个参照，也为后续的数据库维护
                     工作提供了良好的使用说明，版本的升级时也是一个重要的参考资
                     料
                    
     数据要求说明书：明确机房收费系统中各项功能和非功能性需求实现时所需要的数据，
                     根据此数据设计数据库，即对对数据的类型，存储或运行时需要什
                     么的条件来维持进行明细
     测试计划：      为了使测试能够准确有效的进行，明确每个人的责任和任务主要体
                     现在6个方面
                     1.为测试各项活动制定一个现实可行的、综合计划
                     2.为项目实施建立一个组织模型，定义测试项目中的每个角色责任
                       和工作内容
                     3.开发有效的测试模型
                     4.确定测试所需的时间和资源
                     5.确立每个阶段测试完成的标准和要实现的目标
                     6.识别出活动中的各种风险
     测试分析报告：  对测试的结果以及测试的数据加以记录和分析总结，对于今后的软
                     件功能的加强，不足之处的弥补起到了提纲的作用。有利用今后软
                     件开发者分析源码时更有针对性，减少人力财力的消耗
                     检验是否达到了用户的需求
     项目开发总结报告：总结总结就是总括前面的所有过程，进行评断性的结语，即回顾
                       整个开发过程，从需求分析、可行性分析、项目开发计划、设计
                       测试以及维护各个阶段中的经验和出现的问题，为以后项目开发
                       积累经验
     操作手册：      对软件的使用进行说明，是为了让使用本系统的人知道系统有什么
                     功能以及如何正确使用，也为了方便维护工作的人员的工作开展
     用户手册：      为了帮助用户更好的了解和使用该软件，提高用户与软件的亲和度，
                     不仅包括了软件使用的相关信息，还有一些其他相关信息
     开发进度月报： 记录总结一个月的工作，为下个月的工作进行调整方向

    WHO

我们都知道每一个文档的书写都是为了给相关人员看，那么是谁呢，GO  ON

     可行性研究报告：最直接便是系统分析人员，系统开发人员、软件管理员
     项目开发计划：根据目的可得软件开发人员、软件管理人员、用户、系统分析人员
     软件需求说明书：用户、日后维护人员、软件开发人员
     概要设计说明书：软件详细设计人员、软件开发人员、软件管理人员、软件维护人员
     详细设计说明书：软件开发人员，代码编写人员、系统实施人员、维护人员
     数据库设计说明书：数据库设计人员、软件开发人员、软件维护人员
     数据要求说明书：用户、数据库设计人员、软件维护人员
     测试计划：系统测试员
     测试分析报告：开发人员、用户、软件质量管理员、项目管理员
     项目开发总结报告：项目开发人员
     操作手册：所有对本系统进行操作人员，系统实施与维护人员
     用户手册：用户
     开发进度月报：系统开发管理人员（由各个阶段小负责人编写）

     小结：写的过程中便发现不同的资料有不同的写法，自己也很容易混乱。而且文档的编写者和阅读者有意无意就会弄混。仔细一思考会发现其实很简单：

     1、从报告最直接的目的出发，如详细设计说明书就是为了实现系统,代码编写人员便是必不可少的
     2、分清计划文档、说明文档和总结类文档的区别，总结类文档便是这一阶段的总结这一阶段的负责者肯定是必不可少的，以此类推
     3、有一些人是看要求的，软件维护人员、项目总负责人、系统管理者这些都是可以划分在内的

     WHEN

接下来便是这些各类文档什么时候编写出来才不会耽误工程呢？

正如老师所说一图抵万言，一张图画下来每个文档的读者已基本明了，目的也能说出一二，不是吗

    HOW

至于具体如何去写，以后会有无数次机会，实践中去应用吧，正如写这个文档，每天都有新的想法