• 软件开发之我剑!文档管理,我的第一桶金【原】


    起写文档,是程序员最头疼的一件事情,你让我再编一倍的代码都别让我写文档。

    如果是按照一个完整的文档需求,则必须从立项报告、需求分析、概要设计、详细设计、测试用例、测试报告、

    使用说明、操作手册、甚至包括管理文档都必须要有。但是现在情况是别说开发文档,连个简单的txt说明都没有。需求管理、bug管理、功能管理完全一塌糊涂,甚至连个Excel文档都没有。

    甲方提出一个问题,现场直接反馈给程序员,程序员在做其它工作,先问这个问题紧不紧,紧就先做这个,

    赶上验收普天盖地的问题来了,直接一个邮件过来

    “明天甲方要验收,必须要做完!”

    简单的一句,则必须要做。不做能怎么办呢?

    这些问题不应该在项目要验收前的一个礼拜或者更长时间前就该知道要做了吗?

    验收前一天应该是开始部署环境,实际环境测试是否有问题的,而不是说验收前一天说,有20个bug或功能需要修改。你开始改吧!就算改完了,熬个通宵,如何呢?这样出去的东西,我的心里是放不下的。

    我认为文档有四个基本作用:

    1、 文档作为设计、开发、测试和发布的依据基础。

    整个项目的进程中,什么是正确的?什么是错误的?时间点如何截取?测试以何为正确?发布时间点定在何日?

    这些拿什么作为标杆,拿什么作为开发进度的控制依据,拿什么作为项目管理中的里程碑,开发过程中出现了意见分歧,出现脸红脖子粗,拿什么作为评理依据,

    好的,咱们来看文档。

    所有这些问题在开发之前都应该写清楚,标明白。如果中间出现问题,应该附以变更原因和情况说明。及时调整进度并调整文档。

    而不是说,软件的设计开发全靠软件开发人员的主观想象来的,设计成什么样看程序员的审美观;

    开发进度看程序员的心情;

    测试结果根据测试人员的自我判断。

    这样的软件最终是失败的软件。

    就算测试通过、验收通过,又能怎么样呢?只能做一个项目,砸一个客户,永远没有能够长期合作的客户,不是你不愿意合作,而是对方不敢和你合作了。

    整个项目开发的过程和项目管理过程是失败的,整个项目下来,人仰马翻,客户满意度低,项目成员满是疲劳和怨言,项目经理夹在中间左右为难,受尽夹板气。

    2、 文档是说明问题的最好利器。

    其实文档并不是说像传说中的那样,给程序员增加工作量,浪费了工作时间的问题,恰恰相反,文档是向公司向甲方,员工向老板,经理向项目人员证明问题的作的有力证据。

    甲方把一个问题,翻过来调过去的改,今天试试这个按钮,明天试试那个颜色,几天下来,反而说你一个简单的功能没有改好。大哥,是我们没有改好吗?如何证明,咱们翻文档,你的需求修改文档拿出来,何年何月,

    何人提出,修改情况,满意程度,采用与否,备注说明,拿出来一条一条的对啊。你再说我们没有改东西,工作量在这里,你不该说什么了吧。

    其它都有相同的道理,好记性不如烂笔头。老板、经理都是忙的连轴转的人,哪有那么多精力来照顾到所有的细节和问题,所有,开发过程中一定要有文档记录,不然你说我做的不对,设计的不合设计,好的,设计文档搬出来!

    一项一项的查、一条一条的对,谁的问题谁负责!

    维护过程中有问题,好的,发需求更新文档过来,这个需求更改是要经过你们的领导同意的,如果你今天看过了觉得该了好,过两天你们领导一看,什么玩意,再改回去,不能耍猴啊,程序员也是人啊。不过一般领导发话,不论从

    项目还是从公司最后还是要改的,那好咱们计工作量啊。一个一个都列在这里;有bug,好的,发bug管理文档或系统中体现出来。对每个bug都记录相关信息,提出时间,提出人员,提出原因,修改要求等等。开发人员甚至可以

    在bug管理系统中备注修改内容。因为很多时候,我们改了,很长一段时间过后,却不知道当初怎么改了,为什么改了,甚至不知道需求是谁提出的。文档则在这方面提供了一个有利的工具。

    文档对控制项目的开发更是功不可没,软件开发节点、软件开发里程碑、需求和设计等等,一个项目如果有这些文档在手,还怕与别人谈起工作时无甚可谈,成竹在胸。

    3、文档是项目管理的重要工具

    Project 总是和 Manager 在一起的,为什么,项目必需管理,不需要管理的东西,那就不叫项目。

    所以,不要犹豫的负担起你的责任。但是如何管理是关键。

    管理理念,管理方法的书一大堆,我也不够那么高深的知识来告诉你如何管理。不过我认为在软件项目管理中,文档是必不可少的。

    需求分析,设计说明、项目进度、Bug跟踪、甚至个人的工作安排的汇总,都能够做为项目管理中的总结和经验。

    不能一个项目做完,除了一个安装包,其它的什么都没有留下,甚至数据库都只是安装在服务器上,如果服务器挂了,这个数据库就只能靠程序员读代码再还原了。

    4、 文档是公司的重要财富

    如何能够总结、分析问题,如何能够纵览整个系统发展过程。一个项目结束、留下来的除了项目代码、行业经验、应该还有相关文档。这些都是公司的财富。

    控制需求、设计、进度、测试。这些都要从文档中来,没有文档就没有依据,有什么问题,咱们拿来文档说事。

    但是目前的代码完全是个人在做,一点点开发文档都没有,更别说其他的如设计文档,数据库说明,开发文档,详细设计类似的文档了。

    数据库在公司的服务器上,如果服务器挂了呢?如何建立一个30张表的数据库?公司还有谁记得数据结构?

    一个包含10多个模块的代码在一个人手里握着,如果程序员应付其他项目出差了,或者跳槽了?

    这个代码谁来读?找个新手来读?找个老手来看?、

    有些人觉得看代码不如写代码,提出申请,重新写一遍!该如何裁决?

    恐怕在读代码上花费的时间和精力远比当初写下设计文档要花费的多得多。

    老板都知道,花费了时间就相当于花费了金钱。

    文档在软件开发和项目管理中是必须的。

    文档并不是神马浮云!

    没有文档,你的项目和代码才都是浮云。

    本文属作者原创,转载请注明出处!

  • 相关阅读:
    C# 视频监控系列(11):H264播放器——封装API[HikPlayM4.dll]
    php框架
    ExtJS带验证码登录框[新增回车提交]
    ant 读取环境变量的值
    Apache Velocity实现模板化
    23种设计模式概述
    android资源下载
    无序hashset与hashmap让其有序
    PermGen space错误解决方法
    设计模式之代理模式(Proxy)
  • 原文地址:https://www.cnblogs.com/googlegis/p/2978895.html
Copyright © 2020-2023  润新知