1、首先,文档的读者定位要清楚,初级用户、中级用户以及高级用户应该有不同的定位和版块。
2、文档中用到的术语要与目标的读者相适应,标准定义与业界规范相符合。
3、检查所有信息是否真实且正确,重点检查过期产品说明书中的错误,确认是豸阏恢闲否最新版本,引用是否已更新,尝试链接是否准确等等。
4、查看软件界面,看看重要的分支是都描述到,是否有整个大的功能模块没有描述到的情况。
5、按照文档描述,进行实际的操作,检查软件执行结果结果是否与文档描述的相同。
6、关键步骤的描述应该有粗体或背景色提示,合理的页面布局、适量的图表都可以给用户更高的易用性。
7、检查所有图表与界面截图是不是和当前正在发行的版本是相同的。
8、排查错别字,不要出现有歧义的描述,屏幕截图或图形中的文字是容易遗漏的地方。
9、最后检查印刷打印质量,纸张好坏,包装是否合适等等。