软件测试


网站首页 | 软件测试论坛 | 软件测试培训 | 软件测试博客 | 软件测试杂志 | 软件测试沙龙 | 软件测试下载 | 软件测试顾问
业界新闻 | 软件测试人才 | 软件测试技术 | 软件测试工具 | 行业软件测试 | 软件测试管理 | 软件质量专栏 | 软件开发专栏
当前位置:首页>>软件测试技术>>其他相关>>正文
优秀软件文档的必备要素
文章出处:zdnet 作者:Scott Withrow 发布时间:2006-02-28

  在项目开发完成了三分之二的时候,风险承担人对一个正在设计的特性提出疑问,提出了这样的问题:

  为什么你花了400小时的时间构建一个全自动的销售点应用程序?我们只需要一个电子数据表来提交我们的销售信息。

  当你拼命地试图回忆当初的需求会议的时候,你的反应只能是可怜说当初在项目开始阶段团队理解出现了问题。

  当然,这是一个很极端的例子,但是却是在项目开发中经常出现。你可以将这个问题归结到需求管理之上。我将这个过程描述为一个包含五个阶段的反复过程,其目标是在项目的生命周期中管理项目开发的捕获、文档、跟踪和交付。下面是这五个阶段的一个简单描述:

  第一阶段:初始化这个阶段从项目请求开始,到项目被核准结束。这个阶段的目标是确定项目是否值得开发,与别的项目相比其优先级别如何。其步骤包括:

  初始项目请求。

  IT区域回顾。

  概要成本估算,CBA,或者预计的ROI。

  第二阶段:确定或启发这个步骤是指详细需求的组织化的和结构化。它包括:

  最初的项目请求的回顾。

  项目风险承担人的初步确定。

  启发计划的完成。

  反复地执行需求启发步骤,包括会见、交流或其它技术。

  初步需求列表。

  商业规则的确定。

  文档,包括使用案例、上下文图表及其它更多内容。

  功能和非功能需求的正式创建。

  和大多数同行一样,我明白软件文档的重要性。不幸的是,在任务开始前我很少阅读文档。相反,我常常像视线不清的父母一样,在装配好他们孩子的自行车之后,还落下一两个零部件没装上。

 

 

 

 

  如果我们明白文档的重要性,那为什么我们不更经常用它呢?然而,许多软件文档存在以下问题:

  · 错误的语法和/或拼错的词语

  · 不完整

  · 过时或不准确

  · 过于冗长

  · 未经解释的缩略语或专用术语

  · 查找信息困难

  存在这些问题的主要原因是软件文档常常被退居次位。工程预算迫使我们优先考虑开发过程中的主要活动,也就是那些可以看得到利润的地方。编写文档需要成本,因而它常常成为一项主观上的活动,而且通常被认为没有重要作用,应该尽量避免。许多项目经理认为客户不需要文档,它只是用来装点门面的。

  软件文档质量差的另外一个原因在于文档撰写者。许多应用程序开发经理认为软件文档的编写是软件开发过程的一个标准组成部分,因此要求开发人员在编码的过程中产出文档。

  尽管这种做法在理论上行得通,但它没有考虑开发人员编写文档的能力。简单来说,技术人员是用来开发软件而不是编写文档的。为了解决这个问题,许多应用程序开发经理雇佣专业技术文档编写者或业务分析师,以期改进软件文档的质量。但这又遇到了另一个难题:专业编写者及业务分析师的技术水平有限。

  解决这个问题要考虑需要编写的文档以及文档的预期读者。一般的规则是,写文档需要团队协作,这样就允许开发人员和文档编写者利用彼此的长处,取长补短。例如,如果预期读者是系统设计师,开发人员需要提供技术细节,然后文档编写者按照正确语法组织和编辑内容。

  不考虑预期读者或专门编写者,软件文档的质量取决于其可用性,可从以下6个方面去评价其可用性:

  · 应用性:文档是否提供相关信息?

  · 及时性:信息是否及时?

  · 准确性:信息是否正确?

  · 完整性:文档是否足够详细而又不会太过拘泥细节?

  · 可得性:文档是否随时可得?

  · 可用性:你能否很快凭直觉就找到所需信息?

  软件文档的最主要目标是传达一个系统的技术要素和使用方法。第二个目标是提供软件开发过程中的需求,决策,行为,角色和责任的书面记录。只有实现了这两个目标,软件文档才真正提供了有意义的信息。


站内搜索
相关文章
◎如何编写企业解决方案书
◎19个主动报错的电脑启动故障现象分析
◎DOS命令大全
◎系统重装后免中毒十招技巧
◎如何制定成功的测试计划
◎Google搜索从入门到精通v4.0
◎如何配置软件测试环境
◎迈向质量阶梯的思考
◎好的测试工程师应具备的素质
◎汉化软件的测试综述
◎如何加强软件开发中的测试工作(2)
◎如何加强软件开发中的测试工作(1)
◎直面软件开发问题
◎Windows系统实用工具集
◎故障模式影响及危害性分析与软件质量
◎软件测试基本方法
◎网管和黑客都必须知道的命令
◎软件产品测试标准
◎漫谈软件测试工程师的角色定位
◎Windows应用程序的GUI测试指南
◎测试人员和开发人员和谐相处的技巧
◎团队精神与企业凝聚力
◎测试小技巧集锦之一黑盒测试
◎企业内部实现软件测试自动化的方案探讨
◎质量保证计划模板
◎测试的主要评测方法(3)
◎测试的主要评测方法(2)
◎测试的主要评测方法(1)
◎如何用正确的方法来写出质量好的软件的75条体会
◎Word安全保护技巧大搜罗
◎如何更好地与开发工程师沟通-给测试工程师的建议
◎第三方模拟测试环境的搭建
◎软件外包测试处理流程
◎建议有效的软件度量过程
◎嵌入式软件的覆盖测试
◎我眼中的自动化测试水平等级
◎联合测试
◎高可靠性软件测试方案探讨
◎QA活动的理解与实施
◎从六个角度分析流程建模
◎故障硬盘数据拯救全攻略
◎测试版本大全
◎程序员修身养性的十大原则
◎建模过程的盲点:软件集成中的软知识
◎ASP+SQL Server构建网页防火墙
◎基于嵌入式DSP的流媒体编解码器
◎软件开发全过程检测及测试自动化
◎PDCA循环小知识
◎想编写出优秀技术文档,先学学这四招
◎Tcl脚本的历史
热门文章
◎软件测试工程师面试问题选登
◎一个初级测试工程师的工作总结
◎软件测试常用术语表
◎测试人员面试三步曲
◎DOS命令大全
◎什么样的测试人员是好的测试人员
◎软件测试基本方法
◎好的测试工程师应具备的素质
◎软件测试入门书籍(2)
◎我在软件公司成长的三年
◎面试官最爱问的问题背后真相
◎软件测试工程师面试题
◎应届毕业生少走弯路的十条忠告
◎有关软件测试的术语定义集锦
◎微软的软件测试方法(一)
◎我的测试经历(1)
◎全景记录:软件测试工程师的一天
◎软件测试步骤
◎谈谈对测试职业的看法
◎漫谈软件测试工程师的角色定位
◎测试需要掌握什么
◎软件测试员自身素质培养
◎测试小技巧集锦之一黑盒测试
◎近10年最强的50本计算机图书,您读过几本?
◎软件测试人员职业发展助手
◎测试要点总结
◎如何制定成功的测试计划
◎测试的主要评测方法(1)
◎什么是ERP,通俗版解释
◎测试经验交流
◎软件测试及其支持工具
◎编写优秀Bug报告的艺术
◎软件产品测试标准
◎从程序员到测试工程师
◎微软的软件测试方法(二)
◎软件测试应遵循的八条原则
◎测试版本大全
◎我的测试经历(2)
◎测试人员的挑战
◎网管和黑客都必须知道的命令
◎QA活动的理解与实施
◎Alpha和Beta测试简介
◎网络最经典命令行
◎想编写出优秀技术文档,先学学这四招
◎个人职业生涯规划发展
◎你适合做测试吗?
◎软件测试的误区
◎我的测试经历(3)
◎软件测试的心理学问题
◎软件测试组织与方法

Google提供的广告