我对文档的一些看法_成都软件开发公司

我对文档的一些看法

作者：zhaozj
发表时间：2020-12-23 11:02
来源：未知

针对软件开发中的文档,每个开发人员都会自己的一些想法.今天想把自己的一些想法写出来,是正好看了这么个帖子*****************************************************************http://www.csdn.net/expert/topic/839/839157.xml?temp=.7803308 ?回复人：?AiWangji(爱忘记)?? mornwoo(疾风之虫)?的观点，我基本赞成。但是有一点我要补充一下。“软件工程实质就是文档驱动” 好像没有这种说法。确实到现在为止的传统软件工程方法大都是以文档来驱动的。但是软件工程无论如何来讲都是以提高软件质量，提高开发效率为目的的。它的本质应该是以工程化的方法提高“软件” 的品质（高质量，低成本）。当某些问题领域，需要某些文档来实现这个目的时，我们就应该采用它，而如果有些文档作用有限且很难维护时，我们就应该省略掉它。软件工程归根到底是为了可使用的软件（包括可执行程序和提供给用户的文档），其他的开发用文档都是为了提高“软件” 的品质而产生的，是“软件”不可缺少的辅助，而不是全部，更不是目的。回复人：?ozzzzzz(希望敏捷)?(??)?信誉：95??2002-07-01?14:34:00??得分:0???????AiWangji对文档的总结很精彩? 软件工程其实很文档不是一个伴生的关系?文档只是软件工程的一个工具? 不能过分重视手段而忘记了目的??? *****************************************************************我有这么些想法(1)文档首先要看项目规模.大的项目里面,面对面沟通的成本比较大,文档的重要性不言而喻;小的项目或理解起来比较容易的项目没必要同大项目一样要求文档面面俱到.(2)文档的质量胜于文档的数量.说了半天都没说清楚,还不如不说,多给人留点看代码的时间.所以文档的撰写人员首先得提高自己的总结归纳及表达能力.(3)不要太拘泥于文档的格式,多点图文结合的方式,比全篇都是表格+文字的固定格式通常具有更好的效果. 有的人有自己描述问题的形式,如果被格式框住反而可能不知所云.(4)不要为完成任务而写文档,如果有这样的想法文档的质量难得保证.最好是让写文档成为开发人员的习惯,而不是一种强制.to be update...