在有些项目中,很多的模块的操作手册和验收文档是由开发人员编写,而他们在编写的时候,不是注重文档编写的细节,当文档到测试人员的手头时,文档可能遇到各种各样的问题,最糟糕的是测试人员需要帮他们整理统一文档格式,如果遇到这种测试工作时,就要提高开发人员编写文档的意识,我总结了一些我工作时经验,希望大家可以多多提意见,帮助我不断完善。
首先我会跟测试主管或项目经理反馈,并提供一些文档规范的模块或考察点(即文档规范检查点),让开发人员重新提交文档,测试人员只根据文档检查点来验收文档,这样工作效率比较高,详细内容如:
1、文档标题和文件名的正确性
1) 文档名跟需求名一致,如:XXX需求,文档名是:XXX需求操作手册/XXX需求验收申请表
2) 文档标题名跟需求名一致,如:XXX需求,文档名是:XXX需求操作手册/XXX需求验收申请表
导致不正确的原因:开发人员很多情况下是修改原有其他需求的文档,常常忘记修改文档标题和文件名
2、格式和字体统一
1) 格式不一致的问题,文档里面的标题、标题一、标题二、标题三等格式参差不齐。
2) 字体不一致的问题,有的用黑体,有的用隶书,有的用宋体,等等
规范的操作手册正确的格式和标题如下:
标题:(宋体 二号 加粗)
标题一:(宋体 二号 加粗)
标题二:(宋体 三号 加粗)
标题三:(宋体 四号 加粗)
标题四:(宋体 四号 加粗)(在下的字菜单的字体都是宋体 四号 加粗)
正文字体:宋体 五号
这个根据你们实际的要求定就可以的。
3、文档树型菜单
1)检查文档是否有树型菜单
4、文档的完整性
5、文档的全面性
6、截图
1)流程图截错,跟实际描述的流程不一致,尽量不要拷贝,根据实际操作截图
错误截图:如描述销户业务时,截图却是续装业务流程图
正确截图:根据实际描述的流程进行截图,截取销户业务流程图
2)有些操作手册里的图片是全屏截图的,尽量不要把任务栏截在图片里,
3)操作手册里面的图片排列尽量统一,不要一个很靠左、一个居中,凹凸不平
4)图片格式尽量用后缀.jpg
7、明显错别字
8、项目符号和编号不正确
9、段落
10、页眉和页脚问题
1) 是需要根据文档名来命名页眉
实际提交的操作手册和验收存在三种情况的页眉:
一:XXX需求,页眉为:非此需求的-操作手册。
二:XXX需求,无页眉,
三:XXX需求,页眉为:操作手册或需求操作手册(重复名字)。
(待完善,请多提意见,谢谢)