【软件工程】--软工文档总结

背景

看完了软工视频后很是兴奋，然后如饥似渴的开始了软工文档的学习，但是看了培养计划后感觉还是一头雾水。

于是就去找了四五个小伙伴交流，他们毕竟是写过文档了，有一些经验。经过和他们的交流，我渐渐觉得这个文档

也不是很难了，就开始查阅资料。找到了许多巨人，他们的经验总结的很好，让我学习了很多。

开始写的时候还是有些为难的，因为是第一次，万事开头难。写着写着，就有了一点眉目，然后写的更多了，就

感受了文档中也是有很多套路存在的，很多地方都是换汤不换药的，接着就是越写越兴奋。好在现在终于拿下了。

文档总结

我们编写的文档是为了软件服务的，而软件是有生存周期的。一般来说，整个生存周期包括计划（定义）、开发、

运行（维护）三个时期，每一个时期又划分为若干阶段：软件计划与可行性研究、需求分析、软件设计、编码、软

件测试、运行和维护。每个阶段都有其各自的文档。如图：

按照其面向的对象和目标，文档可以分为：开发、管理和用户文档。

开发文档

文档名称	预期读者	主要内容
可行性研究	研发人员、维护人员	分析是否具备开发必要性和可行性
软件需求说明书	开发人员和用户	了解用户需求，满足其需求
概要设计说明书	设计和编码人员	对软件进行初步大体上的设计
详细设计说明书	设计和编码人员	在概要设计基础上进一步明确系统结构，完成算法设计、数据结构设计、物理设计等
数据库设计说明书	数据库设计师、数据库管理员	设计数据库
数据要求说明书	数据库设计师、系统测试人员	明确系统各项功能和非功能需求实现所需要的数据

管理文档

文档名称	预期读者	主要内容
项目开发计划	系统主管、研发人员、维护人员	为开发系统做一个详细计划
测试计划	测试人员	说明测试活动的范围、方法、资源和时间进度
测试分析报告	软件开发人员	对测试结果以及测试数据进行记录和分析总结
开发进度月报表	所有开发人员	总结本月工作，包括进度、资金消耗、资源消耗、工作计划和建议
项目开发总结报告	所有开发人员	总结开发经验，找出可完善之处，持续改进

用户文档

文档名称	预期读者	主要内容
操作手册	操作人员	向使用者说明本系统功能以及使用方法
用户手册	用户	为使用者提供使用指南

小结

编写软工文档是为了软件更好的被用户使用而进行的辅助工作，写好了文档，对于软件的开发是很有帮助的，如锦上添花一般。