测试即是文档

文档需要全面,实时更新,并且易懂。我说的全面是指除了介绍程序的功能外还应该覆盖到代码中一些重要的地方。对很多人来说文档的重要性不言而喻,但很难保持它的及时性和准确性。糟糕的文档的后果通常会浪费更多的资源和时间。往往都是出于一些错误的原因而编写的文档。
  要求文档的一些原因
  有很多原因导致我们需要编写文档。团队经常会由于一些制度上的要求而编写文档,或者就是纯粹出于无知。下面是一些编写文档的错误的理由:
  有人认为文档和项目的成败息息相关。
  文档能够证明某些人的存在。
  需求方除了文档也不知道要什么好
  要你提供文档的人也就是求个安心,知道事情都OK了
  工作流程提示说,你该创建文档了
  文档都是过时的
  软件文档的一个主要的问题就是它通常都不是最新的。代码的某个部分可能发生了改动,但是文档却体现不出这个情况。这句话适用于几乎所有的文档,影响最大的其实还是需求和测试用例。不管你多努力,文档的过期无可避免。
  文档对谁有用?
  取决于不同的受众,文档的类型和格式也会相应地有所不同。开发人员,测试人员,客户,主管,最终用户都是文档的最大的潜在用户。
  开发人员
  开发人员不应该依赖于文档,因为它们通常都是过时的。除此之外,没有什么文档能比代码本身更能提供详细以及最新的信息了。如果你想知道某个方法做了些什么,看下这个方法吧。不确定某个类是干嘛的?看一眼它。通常只有代码写的太差了才需要给它添加文档。
  使用代码本身作为文档,这并不代表不需要其它的文档了。关键是要避免冗余。如果看一下代码就能获取到系统的详细信息,那么还可以有一些其它的文档来提供快速导读以及更高层面的一个概述的功能。代码本身的文档是回答不了这个系统是干嘛的或者这个系统用到了什么技术啊这种类型的问题。大多数情况下,对于开发人员而言,一个简单的README.md就足够他快速入门的了。像项目描述,环境配置,安装,构建及打包指令这些东西对项目的新成员来说非常有用。但那之后,代码就是你的圣经。产品代码提供了所有需要的详细信息,而测试代码则是作为产品代码的内在意图的一个描述。测试用例就是可执行的文档,而TDD(测试驱动开发)就是实现它的最常见的方式。
  假设你用了某种持续集成的方式,如果测试-文档(这里测试就是文档,文档也是测试)中有一部分不对了,这个用例会执行失败,它将会很快得到修复。持续集成解决了测试-文档不正确的问题,不过它不能保证所有功能都是有文档的。由于这个原因(当然也有其它原因)测试-文档应当用TDD的方式来创建。如果在代码开发前,所有的功能都定义成测试用例,那么测试用例就能作为开发人员的一个完备的最新的文档了。
  那团队的其它成员怎么办?测试人员,客户,主管,还有其它非码农呢,他们可能无法从产品和测试的代码中获取到所需要的信息。
.......
本文转自51Testing软件测试网

测试即是文档

时间: 2024-10-30 06:14:39

测试即是文档的相关文章

【测试基础】测试产出的文档“们”

测试计划方案文档 通常情况下,测试计划和测试方案可合为一个文档 文档说明: 包含文档目的和读者对象 文档目的:编写文档的目的.文档时用到的约定和文档的编排方式 读者对象:包括部门经理/高级经理.项目经理.项目组.测试人员.配置管理员及其他相关人员 术语与参考: 包含参考资料与术语解释 参考资料:填写本文档时使用的参考资料,如详细设计文档.开发文档等 术语解释:解释测试人员使用的专业术语,如集成测试.冒烟测试的含义等 测试计划概述: 包含测试系统概述.测试目标.测试方法.测试里程碑.测试系统发布及

iTOP-4412开发板-can测试工具使用文档

本文档介绍如何使用 can 工具测试 can. 给用户提供了“can_libs.rar”以及“can_tools.zip”压缩包,分别是 can 工具需要的库 文件和 can 工具二进制文件. 注意开发板需要有 can 模块才能使用正常使用 can 测试工具.本文档适用于 iTOP 所有开 发板. 下面介绍一下测试工具的使用方法. 1 硬件连接 作者测试 can,使用的是两块迅为开发板.两块开发板 can 的连接为“can-A 连接 can- A,B 连接 B”,imx6 的板子是 can 的“

python文档测试

def average(values): """ compute average value >>> print(average([20, 30, 10])) 20.0 >>> 上面测试的语法>>> 后面需要空一格,否则测试缩进错误 测试完如果文档还需要写其它注释,则以>>>  结尾,否则这段注释 也会被当为上面测试的输出结果,这样明显不是我们希望的输出结果 :param values: :return:

软工测试文档

一.软件测试部分 (一) 软件测试计划 引言 本部分介绍测试基本情况和要求,包括编写目的.项目背景和术语等. 1.1编写目的 为网页测试建立计划,供网页测试人员作为网页测试实施时的参考. 1.2专案背景 介绍项目的背景和范围等. 本项目由华中农业大学软件工程学习小组提出,由华中农业大学信息学院2017级计算机科学与技术专业学生完成. 本项目应用范围为对果蔬饮食感兴趣的师生. 1.3术语定义 包括软件和测试方面的基本术语. 白盒测试:白盒测试是一种测试用例设计方法,盒子指的是被测试的软件,白盒指的

测试文档(final)

1 引言 1.1编写目的 编写本测试计划的目的是: (1)     为整个测试阶段的管理工作和技术工作提供指南同时确定测试的内容和范围,为评价系统提供依据: (2)     此外还帮助安排测试活动,说明对资源的需求: (3)     说明测试结果的评价指标. 本文档的主要内容包括: (1)     测试系统简介 (2)     测试方法 (3)     测试标准 (4)     测试计划 本文档的预期读者是: (1)     开发人员 (2)     项目管理人员 (3)     测试人员 1.

逆转海绵组测试文档

1.引言 本部分介绍测试基本情况和要求,包括编写目的.项目背景和术语等. 1.1 编写目的 为软件测试建立计划,供软件测试人员作为软件测试实施时的参考. 1.2 项目背景 <海绵宝宝>是一部1999年发行的美国喜剧动画,可以说是一部和我们同龄,陪伴我们成长的一部动画,它的内容搞笑,轻松解压.<逆转裁判>CAPCOM公司制作的法庭辩论型AVG游戏,在游戏中玩家扮演辩护律师,在假象规则的序审法庭上与检察官进行辩论,通过追问和质疑嫌疑人和证人,为委托人获得无罪判决是最终的胜利目的. 2

软件测试文档

在软件测试中的流程中,测试文档也是一个重要的流程,所以测试人员也需要学习测试文档的编写和阅读. 一.定义: 测试文档(Testing Documentation)记录和描述了整个测试流程,它是整个测试活动中非常重要的文件.测试过程实施所必备的核心文档是:测试计划.测试用例和软件测试报告. 二.测试文档的重要性 软件测试是一个很复杂的过程,涉及软件开发其他阶段的工作,对于提高软件质量.保证软件正常运行有着十分重要的意义,因此必须把对测试的要求.过程及测试结果以正式的文档形式写下来.软件测试文档用来

js文档碎片

今天看视频发现个有意思的东西,叫做文档碎片?文档碎片是什么呢?先卖个关子. 平常我们在向文档中插入节点的时候可能创建了节点就马上插入父元素,因此浏览器会一直渲染.插入的数量少可能还没影响,可是当插入的节点成千上万的时候,会发现浏览器卡顿了......如何解决这种问题呢?这里我们就要用到文档碎片了.在创建节点之后我们可以先把节点append在文档碎片上,在将所有的节点append之后再将文档碎片append在父元素上,理论上会快一些.经测试,有些时候要快一点^_^...... 1.普通插入 <in

基于DevExpress实现对PDF、Word、Excel文档的预览及操作处理

原文:基于DevExpress实现对PDF.Word.Excel文档的预览及操作处理 在一般的管理系统模块里面,越来越多的设计到一些常用文档的上传保存操作,其中如PDF.Word.Excel等文档,有时候是通过分布式的WCF技术实现数据的显示和处理,因此希望直接预览而不需要下载文件,这样能够给我们提供很多的方便.在DevExpress里面,提供了相应的控件来显示和处理这些文档,本文主要介绍如何利用DevExpress的控件实现对PDF.Word.Excel文档的预览和操作处理. 1.PDF的预览