当前位置: 首页 > 互联网, 观点 > 正文

撰写简单的软件开发文档

在软件开发的过程中,有些人不习惯写文档,甚至很简单的文档也不愿意去写。他们认为文档总是花费时间,而且作用也不大。我想说的是这个作用可能对自身感觉来说不大,但是对他人,对整个团队的作用还是很大的。有时我们总是乐于翻开项目经理或是设计分析师的文档,认为他们的文档很有作用,却又反过来对自己要写的文档不知如何下手,甚至有些不屑,这种截然不同的反应是不是觉得很矛盾。

暂且不说整个项目系统的开发文档,这个文档是需要项目负责人全盘考虑,并实时更新的文档,需要记录某个项目的立项到分析,再到设计,最后到实施等等一系列环节的文字描述。大部分软件的开发离不开版本升级,功能升级。所以,抛开整个项目,当我们在应对某一次的新功能,新需求或需求变更时,能否写一个简单的开发文档呢。根据我的经验,我认为是有必要的。

首先,该文档能够罗列一些具体的需求项,能让我们清晰的知道,此次开发需要完成哪些功能。从而就不用在开发的过程中不断的翻找邮件,不断的询问客户,来确定需求。也不至于将功能点遗漏。而且,我们还能在开发的过程中及时的补充和深化需求的细节,从而保证我们在开发的整个过程中,有完整的需求列表。

其次,开发文档需要简单描述我们在分析需求时的逻辑转化。或是从需求中得出我们需要的注意要点,或是需要进行数据库的结构支撑等等。或将需求拆分成功能的实现逻辑,以帮助我们在开发的过程中理清思路。提高我们在开发中的效率和准确性。也是作为我们在动手写代码之前一次全盘的思考。

第三,开发文档可以简单记录一些重要的代码结构,修改的存储过程,一方面为了升级的需要,另一方面清楚自己改动过哪些代码,或是对代码做了哪些重构等等。记录的是开发过程中详细设计的要点与难点。

第四,开发文档有助于你及时反馈开发进度,方便与其他开发人员或项目经理进行沟通与交流。在没有开发文档的情况下,沟通与交流往往需要实时的整理与总结,而这往往会造成信息的不全面或是没有深度。而开发文档可能是整个开发过程中的记录与要点的提取,并能反应到整个的开发过程,将很容易展示开发要点给你的同事或领导,有助于通与交流。

开发文档也不应过于复杂,语言也应提炼和简化,也不必面面俱到。我的开发文档一般有以下几个大的要点:需求分析:罗列需求要点;逻辑设计:拆分需求,转化成系统实现的描述;详细设计:具体的代码结构或数据库结构设计;代码:重要代码,修改的表与存储过程;小结:开发中碰到的一些问题。另外还可附录一些简单的UI,再给你的文档写一个清晰的文件名称:比如开发日期加上版本或主要功能名称等等,并与其他开发文档统一管理起来。久而久之,当你养成这个习惯,写文档也会变得不再那么难了。

本文固定链接: http://www.byhard.com/?p=1012 | 海纳百川

该日志由 byhard 于2013年06月19日发表在 互联网, 观点 分类下,
原创文章转载请注明: 撰写简单的软件开发文档 | 海纳百川
关键字: ,

撰写简单的软件开发文档:目前有6 条留言

  1. 地板
    空渡.博客:

    写文档,看起来很重要,可惜我们公司没有执行这个流程!

    2013-06-21 09:35
    • byhard:

      那就自己去这么做吧,相信有帮助,加油。

      2013-06-21 17:18
  2. 写文档神马的最麻烦了

    2013-06-22 20:59
    • byhard:

      有些时候重要的东西往往很麻烦。

      2013-06-23 11:12
  3. 沙发
    LuckyMoke:

    这个必须要啊,对于像我这样忘性大的人,不写点什么,项目做着做着就把自己搞糊涂了!

    2013-06-22 22:34
    • byhard:

      嗯,多记记还是很有好处的,有时还能从代码中脱离出来,进行一番思考。

      2013-06-23 11:12