文档类型
用户手册
安装和设置指导
联机帮助
指南、向导
样例、示例和模板
授权/注册登记表
最终用户许可协议
读者群:文档面向的读者定位要明确。对于初级用户、中级用户以及高级用户应该有不同的定位
术语:文档中用到的术语要适用于定位的读者群,用法一致,标准定义与业界规范相吻合。
正确性:测试中需检查所有信息是否真实正确,不出现错别字,查找由于过期产品说明书和销售人员夸大事实而导致的错误。检查所有的目录、索引和章节引用是否已更新,尝试链接是否准确,产品支持电话、地址和邮政编码是否正确等。
完整性:对照软件界面检查是否有重要的分支没有描述到,甚至是否有整个大模块没有描述到,主要是测试文档内容的全面性。
一致性:检查文档描述与实际结果的一致性。按照文档描述的操作执行后,检查软件返回的实际结果是否与文档描述的相同。检查所有图表与界面截图是否与发行版本相同。检查样例与示例,像用户一样载入和使用样例。如果是一段程序,就输入数据并执行它,以每一个模块制作文件,确认它们与描述的一致性
易用性:对关键步骤以粗体或背景色给用户以提示,合理的页面布局、适量的图表都可以给用户更高的易用性。需要注意的是文档要有助于用户排除错误。不但描述正确操作,也要描述错误处理办法。文档对于用户看到的错误信息应当有更详细的文档解释。
无二义性:不要出现有二义性的说法。特别要注意的是屏幕截图或绘制图形中的文字。
印刷与包装:检查印刷质量;手册厚度与开本是否合适;包装盒的大小是否合适;有没有零碎易丢失的小部件等等