软件工程笔记之 – 另外一面

需要什么样的文档

1.  目的。主要功能,开发原因。

2.  环境

3.  范围。输入的有效范围是什么

4.  实现功能和使用的算法。

5.  输入,输出格式。

6.  操作指令。

7.  选项

8.  运行时间

9.  精度和校验

流程图

       流程图不应该过于吹捧,它只是体现软件逻辑结构的一种手段,并且尽量画它在一页纸上。逐一记录的详细流程图过时而且令人生厌,它只适合启蒙初学者的算法思维。

自文档化的程序

       文档的解决方案是“合并文件”,即把文档整合到源程序。这对正确的维护是直接有力的推动,保证编程用户能方便、及时地得到文档资料。这种程序被称着自文档化。

       现在看来在文档中保含流程图是一种笨拙的做法。考虑到流程图方法的落后和高级语言的使用占统治地位,把程序和文档放在一起显然是很合理的。

posted on 2005-10-24 17:14  dragonpro  阅读(523)  评论(2编辑  收藏  举报

Free Web Counter