人月神话读书笔记(15)----另外一面
来源:互联网 发布:bit.edu.cn域名代表 编辑:程序博客网 时间:2024/06/07 03:27
另外一面
英国巨石阵是世界上最大的没有文档说明的“计算机器“。4000-5000年前古人没有留下只言片语说明巨石阵的用途,至今考古学家对古人建筑巨石阵的目的莫衷一是。
比喻文档匮乏会使软件产品难以为用户接受,故而使用文档在软件项目中相当重要。
对软件编程产品来说,程序向用户呈现的(文档)和提供给机器识别的内容同样重要。
需要什么样的文档
- 每个用户都需要一段对程序进行描述的文字。可是大数文档只提供了很少的总结性内容,无法达到用户要求。为了得到一份有用的文字描述,就必须放慢脚步,稳妥地进行;
- 每一份发布的程序拷贝应该包括一些可以例行运行的小测试用例,用用户提供信心;
- 对于必须修改程序的人而言,他们需要程序内部结构文档,同样要求一份清晰明了的概述;
流程图
- 流程图是被吹捧得最过分的一种程序文档。很少有程序需要一页纸以上的流程图;
自文档化的程序
- 合并文件,即把文档整合到源程序。这对正确维护是直接有力的推动,保证编程用户能方便、及时地得到文档资料;
- 文档是通过程序结构、命名和格式来实现的,所有这些必须在第一次书写代码时完成;
0 0
- 人月神话读书笔记(15)----另外一面
- 人月神话-另外一面
- 人月神话读书笔记(2)-人月神话
- 人月神话读书笔记(2)----人月神话
- 读书笔记-人月神话15
- 人月神话读书笔记(四)
- 人月神话读书笔记(五)
- 《人月神话》 读书笔记(一)
- 《人月神话》 读书笔记(二)
- 人月神话读书笔记之二人月神话
- 人月神话读书笔记(1)-焦油坑
- 人月神话读书笔记(1)----焦油坑
- 人月神话读书笔记(3)----外科手术队伍
- 人月神话读书笔记(5)----画蛇添足
- 人月神话读书笔记(6)----贯彻执行
- 人月神话读书笔记(8)----胸有成竹
- 人月神话读书笔记(9)----削足适履
- 人月神话读书笔记(10)----提纲挈领
- ExtJS 4.1 TabPanel动态加载页面并执行脚本
- android实现底部菜单栏
- 学习之maven(3)
- Spring aop 注解方式怎么获得执行了目标的某个方法?
- 网站建设-PHPWAMP 学习笔记
- 人月神话读书笔记(15)----另外一面
- 开源项目Baby学习
- 获取iOS设备唯一标识
- 比较不错的JS视频代码,简单灵巧
- CodeForces 567B Berland National Library
- jsp学习(一)
- iOS md5编码
- iOS Core Animation: Advanced Techniques中文译本
- solar常用网站