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

做最清晰的项目记录

我们在开发项目时,最初的资料可能仅仅来自用户的口头说明,或是用户提供的相关单据,或是用户现实生产工作中的相关流程。但这些资料,语言文字对软件开发项目来说是远远不够的。软件项目应该是一个有始有终,环环相扣,互有联系的结合体。应当包括各种文档,图文,表格,计划,组织等等一个综合的体系结合。随着软件开发的深入,随着业务的不断细化,功能的不断增强,软件本身往往也变得越来越复杂,有时相对看来会表现的非常臃肿。但是,这并不意味着我们软件项目的越来越好,对项目的掌控越来越好,甚至有可能会感觉失去对项目的控制。因此,我们需要对项目有一个很好的记录,无论是项目经理,软件开发人员,甚至是实施人员,终端的用户都应该对整个项目系统有一个综合的认识。而不是从各种纷繁复杂的,超多的文件文档,需求,实施方案,错误记录,改量方案去寻找正确的业务理解。这不但会花费大量的时间,而且重复的思考和消化会浪费大量的时间。这些对项目的理解都是不利的。

多年的软件开发经验,让我明白仅仅用大脑去记忆整个项目的各个流程,细节,要点是非常困难的。你不得不去翻阅数据字典,流程文档,甚至打开数据库中的某个特定的存储过程,从而去判断之前的处理逻辑。需求,数据字典,数据库对象(包括存储过程,函数,视图),版本更新,功能改进穿插在一起,从各个文档中穿越,让你无从适从。我们该如何掌控我们的项目,我们该如何管理我们的文档,我们该如何清楚明了的知道我们的项目到底有哪些功能,我们的项目的这个功能是由哪些数据库对象组成的,我们的这个功能是怎样的一个逻辑或是处理方法。我们的项目应该给二次开发者,或是新用户,或是新的测试人员留下一个快速学习的窗口呢?

记得刚参加工作时,用户的需求往往是项目经理或是开发人员直接从用户那边问过来的。对,的确是问过来的。用户只会从业务的角度去描述他碰到问题,及他想要的结果。由此,通过你不断的讯问,你才能将这个需求转化成系统可处理的逻辑,并将之确定为需求并记录下来,然后再确定结构设计和详细设计,中间可能会牵涉到流程和数据库的设计。我习惯将每次的需求更新记录下来,并单独标上时间,记录详细的设计方案,以及更新中注意的要点,单独成文档,同时也会去更新独立成册的数据字典。数据字典,系统流程,更新文档构成了我的项目中所有文字档案。后来,我发现这之间缺少了最重要的功能模块文档。我们的项目系统大多数是以功能模块划分的。虽然数据字典中已有明显的模块区分,但缺少对功能的介绍及业务的细节要点。因为,我又创建一个关于整个系统的文档,名称取做All of …。意思是某某某项目记录。包括系统目标,业务流程图,数据表记录,重点存储过程,视图介绍,当然最多的是功能介绍,业务介绍及系统处理方式。我会定期的去更新这个文档,将最近的业务需求,模块增加,数据库对象增加等等所有我认为可以添加的一切增加到这个文档之中。一直让文档保持在最新的状态。

但这样也有个问题。越来越多的项目不再是一个人开发完成的,一个人也不可能了解整个项目的全部;word文档不利于多人的分享与更新;而且为了保证最新的文档,旧的或是错误的描述往往被删除,而没有历史记录。也可以这样说,word记录项目变得有些原始和落后了,在开放分布式的团队开发中,项目的记录需要大家的努力,需要团队成员都来添砖加瓦,项目的记录才能更加的详细透彻,全面。因此,需要一个公共的项目记录平台,在这个平台上来记录整个项目开发过程中的一切,从而更简易的了解整个项目的功能。

如何或是说从哪几个方面去记录整个项目呢?我分了以下几个方面:1.版本,2.功能,3.数据库对象,4.数据库对象编辑。系统的更新发布离不开版本的确定,新老版本之前往往会有功能的不同,会有数据库对象上的新增,修改或是删除。功能将系统分成各种不同的模块,记录整个系统的方方面面,或是某个业务逻辑的处理方法。数据库对象往往应用于各个功能模块之中,或是被多个功能模块所共用,或是因为系统版本的升级而变化。总之,项目记录的这几个方面彼此相互联系紧密,共同支撑着整个项目的记录,从而保证只要是项目中的功能都能找到相应的版本及数据库对象,或是功能做了哪些改进。

做软件,做项目,最终的结果是要知道我们的软件是如何组织的,我们的项目团队成员也能够对项目有一个整体的认识。我们能够从文档或是平台中找到任意我们想从这个项目中了解的内容。而不仅仅是通过讯问,或是再次讨论的方式从他人那里获取业务的理解。我们需要有最晰的项目记录,需要一个项目记录的平台,从而让项目的团队成员也更加非常的有成效的工作。我在这里提出了这样的一个思考,并接下来根据上面的思考去实现这样的一个平台,为自己今后的团队工作提供一个便利。

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

该日志由 byhard 于2012年12月04日发表在 互联网, 观点 分类下,
原创文章转载请注明: 做最清晰的项目记录 | 海纳百川
关键字:

做最清晰的项目记录:目前有24 条留言

  1. 学习了,很有帮助!

    2012-12-04 21:58
    • byhard:

      谢谢支持。

      2012-12-10 21:27
  2. 9楼
    润初颜:

    做软件,做项目,最终的结果是要知道我们的软件是如何组织的,我们的项目团队成员也能够对项目有一个整体的认识。

    2012-12-05 09:49
    • byhard:

      你觉得呢,这句话?

      2012-12-10 21:27
      • 就是觉得很有道理呀!

        2012-12-11 17:09
        • byhard:

          嗯,是这样的。

          2012-12-11 17:20
  3. 8楼
    04727:

    不错,分享了

    2012-12-05 11:10
    • byhard:

      嗯,不过要理解其中的精髓是最重要的啦。

      2012-12-10 21:28
  4. 项目的纪录确实很清晰的说。

    2012-12-05 13:13
    • byhard:

      你是说你们的项目吗?那就恭喜你们啦。

      2012-12-10 21:28
      • 不是的,我是说这篇文章所写的项目纪录很清晰,嘻嘻。

        2012-12-11 15:03
        • byhard:

          啊,那我理解错误啦,不过谢谢你的夸奖啊。

          2012-12-11 17:03
  5. 学习了。。以后常 来

    2012-12-05 22:46
    • byhard:

      欢迎光临,也谢谢你的支持。

      2012-12-10 21:28
  6. 5楼
    三格网:

    看了一遍,很有帮助。

    2012-12-06 11:01
    • byhard:

      这让我很欣慰啊,对大家都有帮助这也是我最希望的事情。

      2012-12-10 21:29
  7. 不错,学习学习

    2012-12-06 11:02
    • byhard:

      呵呵,谢谢,希望多提提意见啊。

      2012-12-10 21:30
  8. 万事开头难,清晰的目标,简介的构架,才能有条不紊的进行

    2012-12-06 14:57
    • byhard:

      对的,项目记录应该伴随项目的始终,不过随着项目的扩大,项目的细节往往很容易被忘记。

      2012-12-10 21:31
  9. 板凳
    监控安装:

    学习 学习 支持

    2012-12-09 11:10
    • byhard:

      嗯,那真是太感谢你了,谢谢你的光临啊。

      2012-12-10 21:32
  10. 1.版本,2.功能,3.数据库对象,4.数据库对象编辑。分析很对

    2012-12-15 10:31
    • byhard:

      软件还没有开发完成,最近一直在忙啊,有时间再分享一下哈。

      2012-12-17 10:29