文档至上(二)
2011-01-13 15:29 Jeff 阅读(221) 评论(0) 编辑 收藏 举报
当我解决前天那个问题后,更确信了文档至上这句话.尤其这个任务由你一个人负责时。
而这个问题,正是由于写的一个文档不够细节而忽略某个文件的改动。
不能相信自己会记住任何理所当然的事情。
永远不要怀疑写文档是否浪费时间。
还有很多小细节,如果不用文档记录下来会很浪费时间
而这些小细节平时还想不到,用到时才会想起
比如一些环境的配置(因为一般来说很长时间才会配置一次,很多时候不会记录下来,但是下次配置时就麻烦了)
比如一些unix命令,不常用,比如在一个很大的文件中查找某个字符串的用法
比如一些犯得错误,如果记录下来,会加速下次debug的速度
还有比如程序的设计架构,初始觉得很简单,没有记录,但是随着时间的推移,想要再记录的时候就很难展开了