关于软件设计文档编写

做了这么多年的软件开发工作，从一个纯碎的软件编码人员，到现在的挂上一个项目经理的名头，担负起一些系统设计及项目管理方面的工作，我一直觉得软件设计文档这方面是我的最大软肋，在这方面也花了好些精力去探索它，总希望能够找到一种适合自己的软件设计文档编写方法，但一直都没有找到，也曾尝试着去套一些国标之类的文档模板，但总是感觉设计思想是有，但写起文档来却力不从心，没办法将系统及子模块设计思想真实的反映到文档上，也经常是事后修修补补还是不尽如人意，以前总听人说，如果你能够将你所要表达的事物清楚的传递给别人，那就说明你对这个事物有真正足够的了解了，看来我的真正的软肋不是在设计文档，而是我的系统设计能够还十分欠缺，以致于我没办法将自己的设计思想用文字表达清楚吧。

 

当然，在这些探索过程中，也不是完全没有收获，基本上，还是搞清了一些文档编写的基本原则，真着今日在家中偷闲，将这点积累总结一下，省得明天又给忘了，呵。

 

在学写文档初期，我总想去套一些国标的文档模板，套了半天，经常发现写出来的文档，连我自己都没有看懂，因此，也总结出来一条基本道理：生搬硬套某些文档模板，机械式的对文档模板进行填表的操作并不能够得到系统所真正需要的设计文档。

 

编写设计文档会起到两个作用：

一，在编写设计文档的过程中对系统进行一个全面思考的过程，由于设计文档也由需求分析，系统设计，详细设计这样逐层深入的设计的过程，因此这有助于系统设计者站在各个不同角度来思考系统，十分有助于全面深入整理整套系统以及发现一些潜在问题，这是系统开发的一个十分重要的过程。

二，我们都知道，现在在企业里开发软件，一般都不会是一个人从头到尾进行开发，多数系统都是有一个团队进行设计开发，这个时候，设计文档就起到了一个十分重要的信息传递沟通的作用，而且在系统开发完成，交付使用后，后期也会有很多的维护工作，这个时候，文档就更显其作用了。

 

基于以上两个作用，我觉得编写文档要了解以下几点：

一，我们了解我们所要写的是什么文档，它的作用是什么，它应该包含的内容都有哪一些，这是写文档的基本前提。

二，编写文档一定不能是应付式的，一定要认真的思考，否则，你就失去这个良好的思考过程。

三，文档是为了表达信息，不是为了符合某种标准，所以，不要过于迁强去适应某种标准，但是，如果既能符种一些通用的文档规范，又能将信息表达清楚，那当然更好了。

三，文档的格式应该清晰明了，要让人一看目录大纲，就对文档整体分布了然于胸，

四，内容表达重在清楚，关键是要将设计思想表达出来，不在写太多冗余性的文字，尽可能配上一些图形来表达思想，因为，人对图像信息的吸收比文字来得快。

 

所谓磨刀不误砍柴工，写文档就是一个磨刀的过程，刀是砍柴的工具，同样，设计文档也是软件系统设计的一个基本工具，古人不是也有过精辟的结论嘛：“工欲善其事，必先利于器”，我们在系统开发前期，将这些工作完善了，那么系统开发起来就会更加顺利，项目的成功率也就更高，后期维护也会更轻松，因此，设计文档同时也是一种功能当代，利在千秋的工作，一定要注意做好。