【软工文档】——总结

前言

       经过一段时间的编写文档，也有些摸透这些文档是怎么回事了，一开始拿到这12个文档，也是很头疼的。

内容

一、文档是给谁看的

二、这些文档是怎样形成的

文档名称	编写阶段	编写人员	预期读者	绘图	内容
可行性分析报告	制定计划	管理员，分析人员	开发人员，管理员，决策者	系统流程图、数据流图、数据字典	分析软件是否值得开发（技术、经济、操作、法律、社会效益）
项目开发计划	需求分析-设计	管理员	开发人员，管理员，决策者	甘特图	对费用、时间、进度、人员组织、硬件设备的配置、开发环境和运行环境的配置进行说明
软件需求说明书	需求分许-设计-编码	管理员，分析人员	用户，开发人员	用例图、简单的数据描述	描述软件的功能和性能以及软件的约束范围——作什么
概要设计说明书	设计	管理员	管理员，开发人员	流程图、E-R图	软件的总的体系结构——怎么做
详细设计说明书	设计	管理员	管理员，开发人员	流程图、E-R图	表示出软件结构的图表、完成算法设计、数据结构设计、物理设计等，详细的描述的逐个模块——怎么做
数据库设计说明书	设计	架构师，开发人员	开发人员	E-R图、关系模型	提供了数据库设计的可视性以及软件支持所需的信息
数据库要求说明书	需求分析-设计-编码	管理员，分析人员	开发人员，测试人员，设计人员	无	了解系统中各项功能和非功能性需求实现时所需要的数据，根据此数据设计数据库
测试计划	设计-编码	开发人员	测试人员	测试用例	确定了测试项，要测试的特征，测试任务，谁来完成每项任务以及需要制定应急方案的所有风险等
测试分析报告	测试	测试人员	开发人员，测试人员	无	对测试的结果以及测试的数据等加以记录和分析总结
项目开发总结报告	测试	管理员	管理员，测试人员	流程图	以方便我们在以后的项目开发中来更好的实施项目的制定开发
操作手册	编码	开发人员	用户	软件结构、IPO图	告诉使用者，本系统提供了哪些功能，以及如何正确地、有效的使用这些功能。
用户手册	需求分析-设计-编码	开发人员	用户	数据结构图、IPO图	为了给使用者提供一个使用指南
开发进度月报	这个开发阶段	管理员	管理员	甘特图	本月完成的情况和下月的计划

后记

       软件文档主要就是了解各个文档都包含哪些内容以及他们面向对象都有哪些，从全局整体出发，宏观上进行把控，学习会变得非常有趣。

       软件工程是我们学习编程的纲领，文档就是整个纲领的灵魂，让我们开发的过程少走弯路。以后在与文档的相伴还有很长的路要走，我们要一起努力加油了。