软工文档总结

 文档主要是项目开发和项目交接的时候起作用,尤其是项目交接的时候.需要注意的是格式,但是一切以使用为准.主要的几个文档是:需求、概要、详细、数据库、用户手册。我们一般常用的是敏捷开发，在这些开发中文档是开发后补充的。注意开发文档的目的是能够根据文档把软件重现。

 

1.可行性研究报告：

目的简要，定义主要是开发中设定的专门的词

接口：内部接口--方法调用

             外部接口：USB、打印等

读者：项目经理、（客户，关键在于是否给项目定价）

注意：在可行性研究报告中，软件的整个框架已经确定

 

2.软件需求说明书:

   这是第一个与用户交流的文档,主要交代了软件的功能与价值。在这个文档中把软件的进行了描述。涉及到了几个重要的图：

1）用例图以及详细用例的说明

        用例图是由参与者、用例、系统边界和箭头组成。是用于描述系统功能的静态视图。

 2）数据流图：从数据传递和加工的角度以图形的方式来表达系统的逻辑功能，数据在系统内部的逻辑流向和逻辑变化的过程，是结构化系统分析的主要的表达工具。

  3）数据流程图：也可以，但是不需要做详细的说明。是描述系统数据流程的工具，将数据独立抽象出来，通过图形的方式描述信息的来龙去脉和实际流程。

   4）原型图：

 

3.概要设计：

  读者：项目经理，开发人员------涉及到数据流图和系统流程图

 

大体框架（包图，解耦合，调层）

 1）包图：在UML中用类似文件夹的符号表示的模型元素的组合。系统中的每个元素都能为一个包所有，一个包可以嵌套到另一个保重。使用包图可以将相关元素归入一个系统。一个包可以含附属包、图表或单个元素。

 

2）解耦合：解耦是把原来引用很紧密的对象通过中间的一层进行分离，不直接引用，可能是只引用接口。

 

3）三层架构：分为表现层、业务逻辑层、数据访问层

表现层：展现给用户的界面

业务逻辑层：针对具体的问题，也可以说是对数据层的操作，对数据业务数据访问层：该层所做的事务直接操作数据库，针对数据的增删改查

3个层次中，系统主要功能和业务逻辑都在业务逻辑层进行处理。

所谓三层体系结构，是在客户端与数据库之间加入了一个“中间层”，也叫组件层。这里所说的三层体系，不是指物理上的三层，不是简单地放置三台机器就是三层体系结构，也不仅仅有B/S应用才是三层体系结构，三层是指逻辑上的三层，即把这三个层放置到一台机器上。

三层体系的应用程序将业务规则、数据访问、合法性校验等工作放到了中间层进行处理。通常情况下，客户端不直接与数据库进行交互，而是通过COM/DCOM通讯与中间层建立连接，再经由中间层与数据库进行交互。

 

4）系统流程图及系统角色之间的关系：要表示清楚

        数据流程图添加进去

        图例要有详细的说明

 

 

5）总体设计：

基本功能

用户接口以及系统内部接口

不能有数据库设计，但是要把相关的功能介绍出来。

确定出系统的框架、功能、结构图

结构图：表示了一个系统 (或功能模块) 的层次分解关系,模块之间的调用关系,以及模块之间数据流和控制流信息的传递关系,它是描述系统物理结构的主要图表工具

 

详细设计：

     对系统做了详细的介绍，对功能以及命名进行了详细的规范。

功能：要具体到每一个功能，具体到输入的参数和返回值

 IO输入输出表：I/O输入/输出(Input/Output),分为IO设备和IO接口两个部分。在POSIX兼容的系统上，例如Linux系统，I/O操作可以有多种方式，比如DIO(DirectI/O),AIO(Asynchronous I/O 异步I/O),Memory-MappedI/O(内存映设I/O)等，不同的I/O方式有不同的方式和性能，在不同的应用中可以按情况选择不同的I/O方式。

  IPO图（用表格表示）：表示输入输出，并把相关的出错信息也列出，各角色之间的关系表达清楚，功能表达清楚。

灵活性：适应各种需求，系统是不是可扩展，可配置

 举例：调用数据库，软件的额灵活性好，则在不同的数据库中都能成功运行。

流程逻辑：注意时序图（它通过描述对象之间发送的时间顺序显示多个对象之间的动态协作。它可以表示用例的行为顺序，当执行一个用例行为时，时序图中的每条消息对应了一个类操作或状态机中引起转换的触发事件）

类图(Class diagram)：是显示了模型的静态结构，特别是模型中存在的类、类的内部结构以及它们与其他类的关系等

N-S:是一种符合结构化程序设计原则的图形描述工具.在N-S图中，为了表示五种基本控制结构，规定了五种图形构件。

1、顺序型

2、选择型

3、WHILE重复型

4、UNTIL重复型

5、多分支选择型

 

接口问题在详细设计中必须解决，主要强调的是内部接口的问题：方法、传参、返回值

 

注释规范：方法和变量等的格式，注意怎么写注释，比如在代码最前端写的这段代码的背景，开发人员，功能等等

 

数据库设计：

       注意在这个时候数据库设计基本完成了，各个字段已经设计好了，在这里需要注意的是：

 

E-R图：

    E-R方法是“实体-联系方法”（Entity-RelationshipApproach）的简称。它是描述现实世界概念结构模型的有效方法。是表示概念模型的一种方式，用矩形表示实体型，矩形框内写明实体名；用椭圆表示实体的属性，并用无向边将其与相应的实体型连接起来；用菱形表示实体型之间的联系，在菱形框内写明联系名，并用无向边分别与有关实体型连接起来，同时在无向边旁标上联系的类型（1:1,1:n或m:n）。

数据字典：是指对数据的数据项、数据结构、数据流、数据存储、处理办法逻辑、外部实体等进行定义和描述，目的是对数据流程图中的各个元素做出详细的说明。

每个表的功能和内容必须写清楚

数据要求：数据类型和精度

测试：包括日期，测试员，功能，测试用例

需要介绍模块用例个测试时候的出错信息。

 

用户手册是针对用户

操作手册针对维护人员的维护和拓展

用户手册和操作手册都需要图解