软工文档总结

引言

软工文档进行了一周的时间，学习了如何给一个系统写文档，一周的时间终于完成了，从最初不知道该怎么写，到后来开始有了自己的想法。在文档结束之前做个总结。

内容

软工文档一共十二个，如下所示：



根据工作流程按照时间顺序将文档分为系统开发前，中，后三个阶段，每个阶段都有每个阶段的指导性文档。对十二个文档根据自己的理解整理了思维导图：



软件开发文档的软件开发使用和维护过程中的必备资料，可以提高软件开发的效率，保证软件的质量，而且在软件使用过程中有指导，帮助，解惑的作用，尤其是在维护工作中，文档是不可 或缺的资料。编写文档时要清楚每个文档是谁写的？写给谁的？每个文档里面主要写的是什么？每个文档编写的目的是什么？从这几个角度出发来进行文档的学习。下面针对每一个文档说说我的理解：

文档名称	编写目的	编写人员	完成阶段	预期读者
可行性研究报告	概括性的说明系统的开发是否可行，对项目的可行性进行分析	开发人员	可行性分析	系统管理人员，开发人员
项目开发计划	确定项目各个阶段的开发计划	管理人员	可行性分析	系统开发人员，系统分析人员
软件需求说明书	阐述用户对系统的需求	用户，系统管理人员	需求设计	开发人员
概要设计说明书	描述系统的整体结构和设计结构	开发人员	需求设计	系统管理人员，开发人员，维护人员，测试人员
详细设计说明书	对概要设计说明书做进一步的补充说明，，明确各个类，接口，设计结构	开发人员	需求分析	开发人员，验收人员，维护人员
数据库设计说明书	准确表达数据库之间的关系及设计，对数据库的设计进行说明	开发人员	需求分析	开发人员，测试人员，维护人员
数据要求说明书	对系统中的数据要求进行说明	开发人员	需求分析	开发人员，测试人员，维护人员
测试计划	为测试人员对系统测试提供基础性信息指导	开发人员	测试阶段	测试人员
测试分析报告	判定系统能否投入使用	测试人员	测试阶段	开发人员，维护人员
项目开发总结报告	总结开发经验，说明开发结果，对系统进行评价	开发人员	系统上线后	管理人员
操作手册	对系统的操作进行详细说明指导，方便系统的操作	开发人员	运行维护阶段	用户
用户手册	为用户提供使用说明，便于用户快捷，正确的使用系统	开发人员	系统上线前	用户
开发进度月报	汇报项目进展情况，处理开发过程中出现的问题	开发人员	开发过程中	管理人员

小结

以上是我对软工文档的理解，第一次编写文档难免想法有偏颇之处，欢迎读者斧正。

写这篇博客第一次用Markdown中的表格符号，感觉非常棒，推荐大家也尝试使用！