前言

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

分述

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

一、《可行性研究 告》

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

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

          系统流程图：

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

二、《项目开发计划》

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

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

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

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

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

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

E-R

图也称实体

–

联系图

(Entity Relationship Diagram)

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

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

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

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

七、《测试计划说明书》

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

          图：可以有甘特图

八、《测试分析 告》

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

九、《项目开发总结 告》

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

十、《操作手册》

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

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

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

 总结：

                    在文档编写的过程中，除了知道文档该包括的内容都有什么还要去了解其中的图，每个阶段的图，尽管现在我们还不能画好图，但图是什么，用什么表示，我们都应该了解，在以后的学习中，逐步去运用。            现在这个图只是现在的理解，可能有不正确的地方，希望大家给我提出建议，有更好的关于图的说明大家可以与我交流！关于IPO表该包含的内容我还不是很清楚。欢迎大家的留言！