首先,软工文档,

     软工文档,也就是计划,设计,描述,使用软件的一些文件,它最大的特点就是固定不变,用来给不同的人和计算机来阅读.在期间,文档起到了桥梁的作用,看这张图很形象:

 

 

     在这里在看一下国家统一规定的13个文档的相关知识.先看一下文档的分类:

 

 

    各个文档的内容:

      1,可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。

      2, 项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。

      3,软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

      4,数据要求说明书：该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统数据文卷作好准备。

      5, 概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

      6, 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。

      7,用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

      8,操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。

      9, 测试计划：为做好组装测试和确认测试，需为如何组织测试制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

      10,测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论意见。

      11, 开发进度月报：该月报系软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

       12, 项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价，总结出经验和教训。

       13,软件维护修改建议:此是为后期维护修改做记录报告用的.

 

   上边讲述了,文档分类以及基本作用,下边我们看文档在软件生命周期的位置: 

 

 

     最后我们看看这些文档的宏观作用,即它们要完成的任务,用这张图展示一下:

 

    对于上边的几个简单的字符,我给大家解释一下:  

       1,"什么",即回答此做什么,哪些需求需要被满足;

       2,"何处"即回答从何处,即所开发的软件在什么环境中实现以及所需信息从哪里来;

       3,"何时"即回答何时干,即所开发工作的时间如何安排;

       4,"谁" 即某些开发(或维护)工作打算由"谁来干?"·

       5,"如何"即某些需求是怎么实现的;

       6,"为何"即为什么要进行那些软件开发或维护修改工作?

 

 

      以上是软工文档的相关内容,下边我们看看UML图以文档的关系:

 

        首先UML图和文档不是一一对应的,除了几个核心图,例如用例图,类图,其它图都是可以再任何文档中出现的.下边就按照开发流程简单说一下:

     在需求分析阶段,主要是Use Case Diagram（用例图）来填充，是面向系统分析人员，需求人员甚至是用户； 在设计阶段，即概要设计和详细设计说明书中是UML图的主要载体，他们可以以UML图为主，比如类图，交互图，活动图，状态图，顺序图等，面向分析人员和 编程人员；而在其它文档中，就可以根基实际情况，实际需要，灵活应变，填充适当的UML图。

 

     综上，为宏观上软工文档和UML图的关系，在写以前，画以前我觉的我们有必要清楚文档的各种作用目标，以及UML图以之对应文档，还有和软件开发过程之间的关系。简单理解，不足之处，请大家提出！

转载自：http://blog.csdn.net/liujiahan629629/article/details/8582054