【软工文档总结之前6个文档（重点篇）】

前言：

                 在软工视频之后的文档项目中，面对的编写文档，对于初次接触文档菜鸟的我，头脑中出现的是：我要从哪开始？我要先写什么？都有什么文档？每个文档都应该写什么？我写的对吗？等等一些还没有做，就已经产生的问题，这些思想是阻碍我们前进的来路虎，米老师在对于问题的指导时，曾经说过：“去做就行了！to do to do done”是啊，我们还没有开始，就已经给自己一个约束了。当自己在完成文档编写之后，自己更是充满了动力！下面我就先总结6个开发文档。希望与大家共同学习！

内容：

   文档的编写需要封面、字体要求、目录、格式等等，每个文档的编写都有属于自己的的内容，所以这些都是需要我们在编写文档之前应该了解的！下面来谈具体的文档。

（一）可行性研究报告：

           核心：编写文档，最终决定这个系统是否进行开发。

           内容：一共包括8项内容，分别是引言，可行性研究的前提，对现有系统的分析，所建议的系统，可选择的其他系统方案，投资及效益分析，社会因素方面的可行性，结论。

           注意的问题：

                   定义：定义是列出本文件中用到的专门术语的定义和外文的首字母组词的原词组。需要的可以定义，便于理解。         

                   性能描述：兼容、小巧和可扩展。

                   对现有系统的分析：机房收费系统是我们独立开发的第一个系统，之前并没有现有的机房收费系统，所以，对于现有系统的分析部分，我们可以不用编写。从这里我们要知道，并不是一个固定的模板适合所有的文档，我们要根据实际情况，有所取得。

                   投资与效益分析：根据具体情况进行分析。

                   结论：在结尾处，如果各部门已同意续注明。

            文档编写人员：系统分析人员

            文档预期读者：管理人员    用户

（二）项目开发计划

            核心：项目经过审核，可以开发了，在开发之前，制作总体的一个开发计划。

            内容：一共包括5项内容，分别是引言，项目概述，实施计划， 支持条件，专题计划要点。

            注意的问题：

                    进度：用甘特图来描述，直观、清晰、

                    支持条件：结合具体环境分析， 从开发中和运行时两个方面来说。    

                    专题计划要点：要清晰、简明 

            文档编写人员：管理人员

            文档预期读者：各个部分的开发人员，项目经理

（三）软件需求说明书

           核心：对软件各方面的需求进行分析的文档，包括用户的需求

           内容：主要包括4个方面的内容，分别是引言，任务概述，需求规定，运行环境规定

           注意的问题：

                   用户特点：这里的用户特点和用户手册的阅读人员是相关的，所以这里的用户特点是需要看懂用户手册的！

                   需求规定中的对功能的规定：这里需要画IPO表，写清输入、处理、输出。

           文档编写人员：需求分析人员

           文档预期读者：用户，开发人员

（四）概要设计说明书

           核心：在用户的需求分析阶段的基础上，对机房收费系统做概要设计，为在需求分析阶段得到的目标系统的物理模型确定一个合理的软件系统的体系结构。

           内容：共分为六个部分，分别是引言，总体设计，接口设计，运行设计，系统数据结构设计，系统出错处理设计。

           注意的问题：

                  系统运行的硬件环境包括：CPU 内存 驱动器 硬盘 显示器 鼠标器 打印机等等

                  基本设计概念和处理流程：应用流程图 表示

                  接口设计：根据开发软件逐一去编写，包括用户接口、外部接口、内部接口

           文档编写人员：管理人员

           文档预期读者：软件开发人员

（五）详细设计说明书

           核心：在概要设计的基础上进一步明确系统结构，为下一步系统的实现和测试做准备。

           内容：包括引言和模块设计说明  

           注意问题：

                  模块设计说明：在第一次机房收费系统，模块设计说明要详细，每个模块需要详细的写，这里的模块设计指的是每个窗体。

           文档编写人员：系统分析人员

           文档预期读者：各个部分的开发人员

（六）01数据库设计说明书

           核心：对于设计中的数据库的所有标识．逻辑结构和物理结构做出具体的设计规定。

           内容：包括四个部分 ，分别是引言，外部设计，结构设计，运用设计。

           注意问题：

                  在结构设计中：概念结构设计需要画ER图

                                           逻辑结构设计需要把ER图转为数据库关系

                  在运用设计中：需要设计数据字典。

            文档编写人员：数据库管理者

            文档预期读者：数据库开发人员

       

            02数据要求说明书

            核心：明确软件工作中相关输入输出数据以及软件内部的数据，为软件开发人员、测试人员提供帮助。

            内容：一共包括三个部分，包括引言，数据的逻辑描述，数据的采集。

            注意问题：数据的描述要正确！

           文档编写人员：数据分析人员

           文档预期读者：数据库人员  软件开发人员。

总结：

        这是开发文档的前六个！下一篇会总结剩下的文档！

                                                                        欢迎大家来指导！