软件文档

/* 以下文档内容,整理于2012年 */

背景

软件文档、程序算法,都是软件的灵魂表达方式。在整个开发流程中,有着重要的作用。

我的软件开发生涯是从高中一年级开始的。但是在那个很傻很天真的年代里,我曾经长期地认为,软件开发就是具体地编写软件,实现软件的功能,满足用户的需求而已。因此那个时候,并不认为软件文档是开发人员必须去做的事情。甚至认为,“开发级别”比较高的团队成员,只要认真完成软件就好,其他的烦琐无趣的工作都不应该由软件工程师来完成。

然而,我这个小小的个人工作室一路走来,从业余逐渐转向专业。随着在校课程学习的深入、个人软件发布的增多、跟用户交流的积累,一些认识上的误区被逐渐端正。

一位优秀的软件开发人员,对待软件文档的态度,就应该像反复推敲算法效率的态度一般。软件文档能为后期的开发指明方向(非常有效的设计蓝图),能为后面的测试阶段提供基础(测试阶段是个细致的工作),能为日后的维护提供思路(一段时间后,没有谁能完全记得之前的想法吧),能为跟用户交流需求时有凭据(交流需求的增进时),能有效解决软件危机问题,也能为自己日后的成长积累宝贵的经验(文档写多后,你也会跟我一样喜欢上这项工作,而不仅仅只写编写代码)。

上面一段所提到的N多优点,绝对不是课本里的那些条条框框。这些是我在成长在积累的过程中,逐一经历和体味到的宝贵经验。o(∩_∩)o

文档列表

以下选取的文档,是我开发过程中积累的部分软件文档。