章12 测试文档

简介: 版权声明:本文为博主chszs的原创文章,未经博主允许不得转载。 https://blog.csdn.net/chszs/article/details/1506556  章12 测试文档软件产品由大量工作和为数不少的非软件部分组成,非软件部分主要是文档。
版权声明:本文为博主chszs的原创文章,未经博主允许不得转载。 https://blog.csdn.net/chszs/article/details/1506556

 章12 测试文档

软件产品由大量工作和为数不少的非软件部分组成,非软件部分主要是文档。
软件文档最常见的是拷贝到软件安装盘的readme文件。
软件测试员通常不限于仅测试软件,而要负责组成整个软件产品的各种部分。保证文档的正确性也在职责范围之内。
1、软件文档的类型
如果软件文档仅有readme文件,测试很简单。要保证该文档包含应有的所有材料,全部内容从技术角度讲准确无误,还要进行拼写检查和磁盘病毒扫描,这就是文档测试的内容。
现在,软件文档要占到整个产品的一大部分。
以下是可以归类于文档的软件组成部分。
(1)包装文字和图形
包括盒子、纸箱和包装纸。
文档困难包含软件的屏幕截图、功能列表、系统要求和版权信息。
(2)市场宣传材料、广告以及其它插页
(3)授权/注册登记表
这是客户注册软件时填写并寄回的卡片,也可以作为软件的一部分,显示在屏幕上让用户阅读、认可,并完成联机注册。
(4)EULA
代表最终用户许可协议。可能在软件安装过程中弹出显示在屏幕上。
(5)标签和不干胶条
可能出现在媒体、包装盒或者打印材料上。
它们还包括序列号不干胶条盒封EULA信封的标签。
(6)安装和设置指导
有时该信息直接打印在磁盘上。对于复杂软件,可以是完整的手册。
(7)用户手册。
主要是联机手册。
(8)联机帮助
联机帮助一般可以和用户手册互换使用,有时甚至取代用户手册。
联机帮助索引和搜索功能,用户查找所需信息更加容易。
(9)指南、向导和CBT(计算机基础训练)
这些工具将编程代码和书写文档融合在一起,一般是内容和类似宏的高级编程的混合体,通常捆绑在联机帮助系统中。
(10)样例、示例和模板
编译器可能用一小段代码来演示如何使用编程语言的某些方面。
(11)错误提示信息
2、文档测试的重要性
软件用户把这些独立的非软件部分当做整个软件的一部分。
好的软件文档以几种方式确保产品的整体质量:
(1)提高易用性
(2)提高可靠性
可靠性是指软件稳定和坚固的程度。
(3)降低支持费用
好的文档可以通过恰当的解释和引导用户解决困难来预防这种情况。
注意:作为软件测试员对待文档要像对待代码一样给予同等关注和投入。它们对用户是一样的。如果没有要求测试文档,一定要把此作为问题提出来并在整个测试计划中包括这部分。
3、审查文档时要找什么
测试文档有两个等级。
如果是非代码,测试就是静态过程,可以视之为技术编辑或技术校对。
如果是文档和代码紧密结合在一起,就要进行动态测试。这种情况属于真正的软件测试。
注意:无论文档是不是代码,像用户那样对待它都是非常有效的测试方法。
仔细阅读,按照每个步骤操作,检查每个图形,尝试每个示例。
如果有简单代码,测试代码是否按照描述的方式进行。
最后,如果文档是软件驱动的,就要像软件其余部分一样进行测试。
检查索引表是否完整,搜索结果是否正确,超级链接和热点是否跳转到正确的页面。利用等价划分技术确定尝试哪些测试用例。
4、文档测试的实质
(1)文档常常得不到足够的重视;
如果负责测试软件中的一个领域,一定要为伴随代码的文档测试做出预算,像对待软件一样给予关注。
(2)编写文档的人可能对软件做什么不甚了解;
文档作者不必是软件功能方面的专家。最重要的是,指出发现的代码中难以使用或者难以理解之处,让它们在文档中更好地解释。
(3)印刷文档制作要花不少时间,可能是几周,甚至几个月。
由于这个时间差,软件产品的文档需要在软件完成之前完稿——锁定。
5、总结
从用户的角度看,软件文档和软件都是同样的产品。联机帮助索引遗漏一个重要条目,安装指导中存在错误步骤,或者出现显眼的拼写错误,都属于与其它软件失败一样的软件缺陷。
如果正确地测试文档,就可以在用户使用之前发现这些缺陷。

目录
相关文章
|
1月前
|
人工智能 搜索推荐 Serverless
使用金庸的著作,来测试阿里通义千问最新开放的长文档处理功能
使用金庸的著作,来测试阿里通义千问最新开放的长文档处理功能
88 7
使用金庸的著作,来测试阿里通义千问最新开放的长文档处理功能
|
7月前
|
Nacos
按照nacos官方文档做的一个测试的demo,有人做过这块吗?是有啥需要注意的吗?
按照nacos官方文档做的一个测试的demo,有人做过这块吗?是有啥需要注意的吗?
48 1
|
14天前
|
安全 测试技术 网络架构
【专栏】编写网络设备割接方案的七个步骤,包括明确割接目标、收集信息、制定计划、设计流程、风险评估、准备测试环境和编写文档。
【4月更文挑战第28天】本文介绍了编写网络设备割接方案的七个步骤,包括明确割接目标、收集信息、制定计划、设计流程、风险评估、准备测试环境和编写文档。通过实际案例分析,展示了如何成功完成割接,确保业务连续性和稳定性。遵循这些步骤,可提高割接成功率,为公司的网络性能和安全提供保障。
|
3天前
|
存储 自然语言处理 测试技术
测试答疑助手:从需求文档到设计文档、测试用例的完整测试过程
本文介绍了如何使用LangChain构建一个基于本地文档和数据的测试答疑助手。该助手能回答自然语言问题,涉及数据统计、查找和组合。实践过程包括:设置API Token,导入LangChain相关库,使用MarkdownHeaderTextSplitter处理不同文档,将文本转换为向量并存储在Chroma向量数据库中。之后,通过查询数据库找到最相关的文本片段,结合大模型(如ChatOpenAI)生成回答。示例展示了询问用户注册用例中特定数据的统计情况,得到了包含表格的详细回答。
11 0
|
2月前
|
SQL Apache 流计算
Apache Flink官方网站提供了关于如何使用Docker进行Flink CDC测试的文档
【2月更文挑战第25天】Apache Flink官方网站提供了关于如何使用Docker进行Flink CDC测试的文档
289 3
|
8月前
|
算法 测试技术 数据安全/隐私保护
没有接口需求文档,如何开展接口测试?建议收藏
没有接口需求文档,如何开展接口测试?建议收藏
|
4月前
|
安全 测试技术
如何根据需求文档写测试用例?
如何根据需求文档写测试用例?
|
4月前
|
索引
如何测试文档?
如何测试文档?
如何测试文档?
|
4月前
|
前端开发 JavaScript API
React 生态系统:路由、状态管理、调试、测试、组件库、文档……
React 生态系统:路由、状态管理、调试、测试、组件库、文档……
41 0
|
9月前
|
测试技术 数据格式
软件测试|没有任何文档,怎么快速了解接口的信息?
软件测试|没有任何文档,怎么快速了解接口的信息?
61 0

热门文章

最新文章