软件测试 第2版 §12 测试文档

测试文档

·         软件文档的不同类型

·         文档测试为什么重要

·         在测试文档时需要找什么

 

§12.1           软件文档的类型

老的文档主要是readme文件, 主要任务如下:

You'd make sure that it included all the material that it was supposed to, that everything was technically accurate, and (for good measure) you might run a spell check and a virus scan on the disk.

 

现在包含更多的内容:

包装文字和图形：

市场宣传材料、广告以及其他插页

授权/注册登记表

EULA. 用户最终许可协议

标签和不干胶条：磁盘标签图见教材

安装和设置指导

用户手册

联机帮助

指南、向导和CBT（计算机基础训练）

样例、示例和模板

错误提示信息

§12.2           文档测试的重要性

提高易用性

提高可靠性：可靠性指软件稳定和坚固的程度。

降低支持费用

 

§12.3           审查文档时要找什么

可能包含动态和静态测试

 

Table 12.1. A Documentation Testing Checklist
What to Check	What to Consider
General Areas
Audience	Does the documentation speak to the correct level of audience, not too novice, not too advanced?
Terminology	Is the terminology proper for the audience? Are the terms used consistently? If acronyms or abbreviations are used, are they standard ones or do they need to be defined? Make sure that your company's acronyms don't accidentally make it through. Are all the terms indexed and cross-referenced correctly?
Content and subject matter	Are the appropriate topics covered? Are any topics missing? How about topics that shouldn't be included, such as a feature that was cut from the product and no one told the manual writer. Is the material covered in the proper depth?
Correctness
Just the facts	Is all the information factually and technically correct? Look for mistakes caused by the writers working from outdated specs or sales people inflating the truth. Check the table of contents, the index, and chapter references. Try the website URLs. Is the product support phone number correct? Try it.
Step by step	Read all the text carefully and slowly. Follow the instructions exactly. Assume nothing! Resist the temptation to fill in missing steps; your customers won't know what's missing. Compare your results to the ones shown in the documentation.
Correctness
Figures and screen captures	Check figures for accuracy and precision. Do they represent the correct image and is the image correct? Make sure that any screen captures aren't from prerelease software that has since changed. Are the figure captions correct?
Samples and examples	Load and use every sample just as a customer would. If it's code, type or copy it in and run it. There's nothing more embarrassing than samples that don't workand it happens all the time!
Spelling and grammar	In an ideal world, these types of bugs wouldn't make it through to you. Spelling and grammar checkers are too commonplace not to be used. It's possible, though, that someone forgot to perform the check or that a specialized or technical term slipped through. It's also possible that the checking had to be done manually, such as in a screen capture or a drawn figure. Don't take it for granted.

 

§12.4           文档测试的实质

文档常常得不到足够的重视、预算和援助。

编写文档的人可能对软件不做什么了解。

印刷文档制作要花不少时间。