人月神话读书笔记(15)----另外一面
2016-07-19 16:38
295 查看
另外一面
英国巨石阵是世界上最大的没有文档说明的“计算机器“。4000-5000年前古人没有留下只言片语说明巨石阵的用途,至今考古学家对古人建筑巨石阵的目的莫衷一是。比喻文档匮乏会使软件产品难以为用户接受,故而使用文档在软件项目中相当重要。
对软件编程产品来说,程序向用户呈现的(文档)和提供给机器识别的内容同样重要。
需要什么样的文档
每个用户都需要一段对程序进行描述的文字。可是大数文档只提供了很少的总结性内容,无法达到用户要求。为了得到一份有用的文字描述,就必须放慢脚步,稳妥地进行;每一份发布的程序拷贝应该包括一些可以例行运行的小测试用例,用用户提供信心;
对于必须修改程序的人而言,他们需要程序内部结构文档,同样要求一份清晰明了的概述;
流程图
流程图是被吹捧得最过分的一种程序文档。很少有程序需要一页纸以上的流程图;自文档化的程序
合并文件,即把文档整合到源程序。这对正确维护是直接有力的推动,保证编程用户能方便、及时地得到文档资料;文档是通过程序结构、命名和格式来实现的,所有这些必须在第一次书写代码时完成;
相关文章推荐
- 只需十分钟,结果大不同 |《深度思考》
- 《洋葱阅读法》读书笔记
- C#生成Word文档代码示例
- 如何使用C#从word文档中提取图片
- jQuery窗口、文档、网页各种高度的精确理解
- 比较全的一个C#操作word文档示例
- Jquery实战_读书笔记1―选择jQuery
- 用JavaScript获取页面文档内容的实现代码
- C#编程实现Excel文档中搜索文本内容的方法及思路
- JavaScript 精粹读书笔记(1,2)
- JavaScript 权威指南(第四版) 读书笔记
- Terry七月Ruby读书笔记(比较详细)第1/4页
- php文档工具PHP Documentor安装与使用方法
- MongoDB快速入门笔记(六)之MongoDB删除文档操作
- MongoDB快速入门笔记(四)之MongoDB查询文档操作实例代码
- MongoDB快速入门笔记(三)之MongoDB插入文档操作
- MongoDB中对文档的增删查改基本操作方法总结
- MongoDB修改、删除文档的域属性实例
- MongoDB快速入门笔记(六)之MongoDB的文档修改操作
- 整理java读书笔记十五之java中的内部类