软工文档总结

  所谓“程序猿最烦两件事，一件是别人要他给自己的代码写文档，一件是别人的程序没有留下文档”，我在软工视频和文档的学习中，逐渐发现此是偏理论且高度概括性的，有些不接地气。但要想走得更远，这些知识又是必须了解的。所以，先总结下来，方便日后的翻阅和反刍。

【软件各周期中所需文档】

（此图是参考的程金鹏的图，感谢分享）

【各文档的预期读者】

人员

文档名

管理

分析

设计

开发

测试

维护

用户

可行性研究报告

√

 

 

√

 

√

 

项目开发计划

 

√

 

√

 

 

 

软件需求说明书

 

 

 

√

 

 

√

概要设计说明书

 

 

√

√

 

 

 

详细设计说明书

 

 

 

√

√

 

 

数据要求说明书

 

 

√

 

√

 

 

测试计划

 

 

 

√

√

 

 

测试分析报告

 

 

 

√

 

 

 

项目开发总结报告

 

 

 

√

 

 

 

操作手册

 

 

 

 

 

 

√

用户手册

 

 

 

 

 

 

√

数据库设计说明书

 

 

√

√（数据库管理员）

 

 

 

开发进度月报

√

 

 

√

 

 

 

【对各文档的详细介绍】

1）  可行性研究报告：

研究此项目是否可行，主要从技术、经济、社会因素方面考虑。

2）  项目开发计划

除了对所需要的软硬件条件进行说明外，还说明了开发进度和人员配置

3）  软件需求说明书

明确用户有哪些需求。主要是在功能、性能、精度、时间特性、灵活性、输入输出要求、数据管理能力、故障处理和运行环境等方面进行协调。

4）  概要设计说明书

根据用户提出的要求，明确开发人员需要开发出哪些对应功能。分为总体设计、接口设计、运行设计、数据结构设计和出错处理设计。文档中有“主要模块流程图”、“各使用者的权限”、“数据库中的9个表”。

5）  详细设计说明书

从一般用户、操作员、管理员三个方面分别阐述了其要实现的功能、存储分配等。文档中有“功能图”。

6）  数据要求说明书

顾名思义，此文档主要是对数据方面进行了说明，要根据这些数据设计数据库

7）  测试计划

对各功能块进行测试的计划，软硬件安排等。

8）  测试分析报告

测试出的此系统是否符合预期，有哪些缺陷

9）  项目开发总结报告

这次开发的实际结果和评价，以及总结出的经验。

10）操作手册

系统级别的文档，讲述如何操作，管理该系统

11）用户手册

需求级别的文档，使用说明书

12）数据库设计说明书

提供设计数据库的依据（怎么设计数据库？）

13）开发进度月报

所耗费的时间和费用的阶段汇报

————————我是一条美美的分割线————————————————————————

附录：

（基本定义）

（主要模块流程图）

 

BasicData_info

CancelCard_info

CheckDay_info

CheckWeek_info

Online_info

 

 

 

 

上机信息

Recharge_info

Student_info

User_info

Worklog_info

 

 

 

 

值班信息

 

（各表所代表的含义）