文档的重要性：从程序到产品

自动开始写文档以后，针对自己在开发和部署过程中的很多方面，写了很多文档。文档在软件开发过程的重要性只能靠时间才能让人理解，当然如果你一开始就能够认识到文档的重要性，那你肯定就是个软件天才。:)

从一个程序员到一个软件产品的构造者需要一个过程，这个过程包括编程技术的提高，更多的是思考问题角度的转变。普通程序员思考问题一般都在程序逻辑的角度，如何把给定的功能用最快的速度，最好的算法实现出来就是最大的目标，当然实现了这样的目标以后就可以称得上是一个好的程序员。随着软件的复杂度的增加，软件规模的扩大，就需要对整体软件架构有更多的认识，怎样的架构才能够使得软件虽然复杂，规模庞大，但是仍然结构清晰，非常容易扩展。慢慢的，程序员的思维角度需要向产品的角度来思考。

生命在于过程，对一个人来说如何出生的并不重要，反正都出来了，最重要的是如何高质量的度过这一生。一个软件产品也一样，在整个软件的生命周期中，最重要的就是给用户使用和维护的过程，这个过程的时间将永远超过软件开发的时间（当然，一个彻底失败的产品谈不上给用户使用，更谈不上有生命周期）。而在用户使用和维护的过程中，完整详细的文档就起着决定性的作用。有了详细的文档，产品维护和升级的人员可以随时通过查看文档来了解软件的各方面的信息。

之前的文档比较分散，多了以后，查询困难，有的时候忘记了文档的位置，有的时候为了找一个文档浪费了很多时间。在这种情况下，通过一个Wiki站点来维护所有的文档将是一个不错的选择。

评论

3 楼 ozzzzzz 2008-08-08  

作者在写这个之前显然没有看javaeye以前关于文档的大量讨论。

2 楼 widen 2008-08-07  

文档应该算是基础，记录软件设计的点点滴滴，没了这个基础，如果换一批人，这个产品估计是做不下去了。好的清晰的架构也必须要用文字来描述，否则在开发人员的理解都存在歧义，更谈不上产品的长远发展了。我这里提的文档主要是针对开发人员来讲的。自己的一点体会呵呵。

1 楼 rtdb 2008-07-29  

> 而在用户使用和维护的过程中，完整详细的文档就起着决定性的作用。

我以为没几个用户会看文档。UI设计更重要。



〉 有了详细的文档，产品维护和升级的人员可以随时通过查看文档来了解软件的各方面的信息。

我以为保持产品的适当的发展方向，合理的升级规划，严格的测试才是关键。