软工文档第一次验收,师傅和同伴儿给我提了很多需要改进的地方。还扩展了一些东西。
记录一下,待第二次文档完成时,回顾一下这些问题。
需要改进的地方:
1. 《概要设计》里关于数据库的东西要放在《数据库设计说明书》里。
2. 参考文档不全。与它相关的上个文档,总的计划性文档。凡是要参考到的文档,哪怕是参考一个时间也要写到参考文档里。
3. 定义不对。设计到哪个阶段了,就要写出对应定义出现的名词。
4. 要参考数据库的自考书,学习数据库设计。
5. 格式:
a. 文档的命名要写明是什么系统的什么文档
b. 每个文档都有封皮
c. 目录要学会自动生成
d. 学会使用导航窗体
e. 该缩进的地方要缩进
一些拓展:
1.《操作手册》和《概要手册》的区别
2.自动生成目录
3. 数据库设计的过程
4. 《详细设计》里涉及到的架构图、时序图、类图
5. 《数据库设计》里涉及到ER图,表
6. 数据要求说明书是干什么的。
7. 《项目开发计划》里涉及到甘特图。
8. 《测试计划》涉及的IPO图
9. IPO图与测试用例的关系。
10. 原型图。
通过验收,发现自己对软件工程的概要设计与详细设计两个阶段认识不太清楚。
概要设计,主要成果是系统流程图,要设计出系统的架构。详细设计,详细到看了详细设计说明书,代码呼之欲出的程度。主要成果是数据字典,数据库详细设计。
总的来说,学习编写的几个文档共有13个。我给他们分一下类。
一部分是纲领性的,比如:可行性研究报告,项目开发计划。
一部分是对开发过程中的每个过程起标志和衔接作用的,没有这些文档,下一个阶段执行起来很困难。比如:《软件需求说明书》《概要设计说明书》《详细设计说明书》《测试计划》《测试分析报告》。《数据库设计说明书》和《数据要求说明书》是《详细设计说明书》的补充。它们很重要,且自成一体,所以单独拿出来写。
还有一部分是辅助开发,重管理的比如:《开发进度月报》《项目开发总结报告》。
如果按文档面向的读者来分:
《操作手册》和《用户手册》是面向用户而编写的。开发进度月报,项目开发总结报告是面向系统开发的管理者写的。其他的是面向系统开发人员写的。这里的系统开发人员包括系统分析员,程序员,系统测试人员。
软工文档的总结拖了有一段时间,终于把它给写上了。下回的总结一定做在平时。