论坛首页 综合技术论坛

文档,重要?不重要?有多重要?

浏览 15214 次
精华帖 (0) :: 良好帖 (0) :: 新手帖 (0) :: 隐藏帖 (0)
作者 正文
   发表时间:2006-11-07  
adamzhao 写道
除了需求文档,概要设计文档,用户手册之外,其他的(如详细设计)似乎并不重要,而且最要命的无法同步更新,形同鸡肋。

还是XP好呀

需求文档,概要设计文档,用户手册这三个的确非常重要,用户手册是面子工程,需求文档和概要设计文档是里子工程。
那么详细设计文档是里子的里子了,程序员写代码都是通过它来指导的。
如果说详细设计文档没有或者是乱来的,那么这个项目前期的规划肯定也是乱的,设计上不下功夫,到时候写出来的代码是五花八门。
需求文档,概要设计文档,用户手册,详细设计文档是项目文档中必不可少的。
0 请登录后投票
   发表时间:2006-11-08  
项目达到相当规模时,文档是必需的,但是不要涉及过多的细节,细节性的东西代码已经表达了。文档是代码的一种补充,突出重要问题,隐藏掉代码中的细节。对于一般问题,文档的可读性和阅读效率高于代码。文档作为一种索引,在需要了解细节时,可以快速定位至相关代码的位置。
0 请登录后投票
论坛首页 综合技术版

跳转论坛:
Global site tag (gtag.js) - Google Analytics