【软工文档总结之概括与图形（简要篇）】_操作手册和开发报告区别

       软件工程视频看完之后，进行了实践——编写文档。初次接触文档，有很多不熟悉，但在慢慢的编写过程中，领会了其中的内容，十三个文档的编写，完成之后，更多的是自己的一个成长的经历。文档是软件工程的灵魂，是指导思想，在软件开发过程中注意文档的编写。

      在软工文档的编写过程中一共编写了13个文档：分别是：可行性研究报告，项目开发计划，软件需求说明书，概要设计说明书，详细设计说明书，数据库设计说明书，数据要求说明书，测试计划说明书，测试分析报告，项目开发总结报告，操作手册，用户手册，开发进度月报。

一、《可行性研究报告》

           分析项目是否具备开发的必要性与可行性。

         图：系统流程图和数据流图

          系统流程图：

         系统流程图是概括地描绘物理系统的传统工具。它的基本思想是用图形符号以黑盒子形式描绘组成系统的每个部件( 程序，文档，数据库，人工过程等 ) 。系统流程图表达的是数据在系统各部件之间流动的情况，而不是对数据进行加工处理的控制过程，因此尽管系统流程图的某些符号和程序流程图的符号形式相同，但是它却是物理数据流图而 不是程序流程图。

                                                                                  

                                               

                            

          数据流图：数据流图也称为数据流程图date flow diagram , DFD，是一种便于用户理解和分析系统数据流程的图形工具，他摆脱了系统和具体内容，精确的在逻辑上描述系统的功能、输入、输出和数据存储等，是系统逻辑模型的重要组成部分。

                                                   

                             

 

二、《项目开发计划》

         对系统的开发制定计划，指导整个项目开发工作的顺利进行，为开发的下一步做准备。

         图：甘特图（进度） 甘特图，即以图示的方式通过活动列表和时间刻度形象地表示出任何特定项目的活动顺序与持续时间。基本是一条线条图，横轴表示时间，纵轴表示活动（项目），线条表示在整个期间上计划和实际的活动完成情况。它直观地表明任务计划在什么时候进行，及实际进展与计划要求的对比。

                  eg.

     甘特图可在EXCEL表格中画，可以下载一个甘特图画图软件。

 

三、《软件需求说明书》

        软件需求说明书是需求分析阶段的一个文档，是对软件目标及范围的求精和细化，明确了开发软件的方向,

        图：IPO表（IPO图）

            根据IPO图，绘制IPO表，包括输入、输出等内容。

    

   

四、《概要设计说明书》

 

       概要设计说明书是在用户的需求分析阶段的基础上，对系统做概要设计，为在需求分析阶段得到的目标系统的物理模型确定一个合理的软件系统的体系结构。从而为下一阶段的详细设计做参考，设计阶段将以本文档为核心文档。

         图：流程图    

      

                                                    

 五、《详细设计说明书》

 

          详细设计说明书是在概要设计的基础上进一步明确系统结构，表示出软件结构的图表，完成算法设计、数据结构设计、物理设计等，详细地描述的逐个模块，包括算法和逻辑流程的具体实现方法，设计系统的物理模型等，为下一步系统的实现和测试做准备。

概要设计说明书就够用了，详细设计说明书可以省略。

       图：IPO图    流程图

      IPO图： 

 功能：指模块把输入转换成输出所做的工作。

    eg.IPO图

                               

 

六（1）、《数据库设计说明书》

 

       数据库设计说明书描述了数据库的设计，提供了数据库设计的可视性以及软件支持所需的信息。

       图：E—R图    数据库关系图     数据字典    

              E—R图:也称实体联系图，提供表示实体类型、联系、属性的方法。

                  

E-R

图也称实体

-

联系图

(Entity Relationship Diagram)

，提供了表示实体类型、属性和联

                                

E-R

图也称实体

-

联系图

(Entity Relationship Diagram)

       关系图：将对于E-R图中的每一个实体，都应转换为一个关系，该关系应包括对应实体的全部属性，并应根据关系所表达的语义确定哪个属性（或哪几个属性组合）作为“主键”。

        Eg.

           

         学生（学号，卡号，学生姓名，系别，性别，年级，班级）主键用横线画出，外建用波浪线画出。

                                                          

      这一阶段是确定数据库的逻辑结构和物理结构。

 六（2）、《数据要求说明书》

 

        编写数据库要求说明书的目的是明确系统中各项功能和非功能性需求实现时所需要的数据，根据此数据设计数据库。

       这一阶段进一步确定了数据库中的数据要求。

 

 

七、《测试计划说明书》

 

         制定该测试计划书描述了需要测试的特性、测试的方法、测试环境的规划、测试用例的设计方法、明确测试策略、明确谁来完成每项任务以及需要制定应急方案的所有风险等。

          图：可以有甘特图

 

八、《测试分析报告》

 

     测试分析报告对测试的结果以及测试的数据等写成文档，对发现的问题和缺陷加以记录和分析总结。

九、《项目开发总结报告》

 

      系统的开发工作已经基本完成。对项目开发的总结。

十、《操作手册》

 

       操作手册的目的在于告诉系统的使用者，系统提供了那些功能，以及如何正确地、有效地来使用这些功能。

       图：软件结构图       运行表    安装步骤图

            软件结构图：指的是软件结构

                                 

           运行表：指的是系统运行的过程。

          安装步骤图：安装步骤的截图，更直观！

 

十一、《用户手册》

 

          用户手册为用户说明使用方法，以及给已经使用过或者正在使用的用户在使用过程中遇到问题时提供解决问题的方法。

         图：软件结构图      运行表    安装步骤图（这个把软件的安装步骤用图表示更方便用户查看）

         

 

十二、《开发进度月报》

 

          开发进度月报是及时向有关管理部门汇报项目开发的进展和情况，以便及时发现或处理开发过程中出现的问题。

注意：

      操作手册和用户手册的区别：

操作手册是系统级别的文档，主要针对操作，软件如何安装，是一步一步进行的

用户手册是需求级别的文档，主要针对功能详解，包括要从头开始的服务器配置，系统安装，系统操作，系统维护等等，完全是套成熟的流程模式。

用户手册是包括操作手册的。

                                              

 总结：