RSS订阅欢迎来到Java程序员学习天地!
你的位置:首页 » 项目管理 » 正文

论项目实践中的文档的作用

选择字号: 超大 标准 发布时间:2017年05月19日 | 作者:amour505 | 0个评论 | 176人浏览

软件文档的编制在软件开发工作中占有突出的地位和相当的工作量。但是在实际的项目实践中,开发,测试一直占据着最大两部分工作量。需求的频繁变动,开发的工作量可能还有提高,基本测试又是无法删减的否则测试不充分会影响软件质量。面对繁重的交付压力,临近的交付日期,软件文档的重要性在保证交付的现实面前就显得不那么重要了。

本人在工具软件开发岗位上已工作多年,在先后工作的多个项目中,或多或少的都存在忽视文档的问题。

A项目是项目整体交付,软件文档是作为交付件的一部分。但是该项目组新员工占据绝大多数,项目经理出于可能的项目超期预期,在完成了需求分析和大致的软件概要设计后,将各功能模块分配后就进入了实际开发阶段。而详细设计打算在全部开发完成后,和使用手册一同编写,由各模块负责人编写本人负责相关详设内容。这样既避免了需求变更后需要修改详设文档,又能节省时间。但是概要设计的编写和评审对编码阶段的指导功能也就无从谈起。到功能测试阶段也确实出现由于个别模块负责人设计出错导致的代码紧急返工。而这个问题,本来在详设阶段就应该能发现的。

B项目是一个测试工具,本人负责老版本的维护和新功能的开发。该工具用于产品交付前的功能和场景测试,使用较广。但是由于是个内部工具,并不对外开放,所以没有任何相应文档说明。由于公司战略转型,测试部门有大量新员工入职,而工作的交接并不彻底,多数新员工对该工具的使用没有彻底掌握。在运用中产生大量问题包括环境设置,工具使用,用例编写,这些全部反馈到工具开发人员。开发人员每天花费大量的时间来解释使用问题,影响了开发人员工作效率。最后趁版本重构的机会,特意安排时间编写了使用手册并安排了测试人员参与培训。这样基本解决了测试的使用问题。

C项目是测试设备的配套软件,该软件开发跨度达10年以上,早期的开发人员陆续已离职,而该项目在开发过程中同样没有输出任何文档。面对软件中存在的没有源码的未知插件,单片机软件复用来的代码,完全没有任何注释的接口函数,新的开发人员上手难度极大,问题调试定位难度极大,开发人员疲惫于新增需求和新功能合入后导致各种稳定性问题,项目部门面对人力不足和交付压力,也没有按标准流程进行重构的魄力,这个项目目前只能带病继续下去,出现数次由于软件缺陷导致的用户投诉和应标失败也就不奇怪了。

以上3个项目,都没有按照开发流程输出对应文档,无论是为节约时间完全忽视文档,还是为只满足输出交付件而倒因为果,最终都影响了软件开发的效率。

文档在软件开发中看起来不是必须,“只要产品成功交付了,少文档没关系”;“内部工具项目有没有文档无所谓”;“写代码都来不及,那有时间写文档”,类似的说法也经常出现。但是,软件产品是包括程序,数据机器相关文档的完整集合。文档正是实现对软件开发工程管理的依据,作为里程碑的标志,关键点评审的依据,和交付后使用维护的基础。忽视了文档,就违背了开发规范,忽视了文档对软件开发的指导作用,必将影响软件项目本身。必须要强调文档的重要性,高效率,高质量的开发,分发,管理,维护文档是高效保质的完成软件项目的必要条件。


标签:项目管理

额 本文暂时没人评论 来添加一个吧

发表评论

必填

选填

选填

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。

控制面板
您好,欢迎到访网站!
随机文章
热门文章
热评文章
最近发表