导言
收到一位TW新人的问题:该如何去制订适用的文档测试策略,这方面,有什么标准吗?
好问题!文档测试是保证文档正确性与完整性(Easy to Use)的关键一环。对于文档测试的标准,我没注意到业内出过相关国际国内标准。不过,我很乐意根据以往的工作经验,总结一下我对文档评审与测试方法与策略的心得。
评审类别
对于操作类手册,评审通常分两块:
- 外部评审:由测试工程师(有时会是开发工程师)与产品经理对文档进行评审
有条件时请SME对文档进行综合评测。比如在穆迪时,穆迪产品管理部门有一个由资深银行从业人员组成的SME组。他们会从用户的角度对文档进行评审,为操作手册提供不少实用的案例,加深用户对产品应用场景的理解。这些案例的加入,大大提高了文档的可读性与专业性。
- 组内内审:组内同事互审+ Editorial Review
以我的经验,组内内事互审这一环节对提升文档内容的正确性与一致,发现文档写作规范的作用特别大。
评审要点
- 操作步骤是否正确无误;链接是否有效;
- 功能有无遗漏;
- 对概念性问题的阐述与理解是否正确;
- 概念阐述是否正确反映产品设计意图;
- 表达是否通顺正确;
- 文档组织结构是否合理;
- 文法是否遵循公司写作规范;
- 从近“小白”的角度,考查易懂性、逻辑合理性、文字简洁清晰性
角色侧重点
- 产品经理:2、3、4、5、6
- 测试人员:1、2、3、5、6
- 内审:5、6、7、8
Tip: 对于评审意见的采纳,TW必须要有自己的坚持。比如,在写作时,TW会把一个feature(功能)包装成一个与用户日常操作Task, 但测试的评审出发点是:功能;有时不能领会TW的苦心。这时,TW要与测试进行沟通,据理力争,正确的立场就必须坚持。
文档评审流程
我的经验:Waterfall与Agile流程下评审流程有所不同。
对于操作手册,(此处放流程图为佳)Agile开发模式下:
- Iteration 1开发结束后(也即第二个iteration开始),开始iteration 1文档开发;
- 当iteration 2开发结束时,完成iteration 1的内容开发。将文档发给QA(测试)与给产品经理(PM)测试评审。然后,TW根据意见修订文档。
- 如此往复至所有iteration结束。
- 文档整体定稿,发给QA与PM全文复审。之后,TW根据复审意见修订文档。
- 定稿后,内审开始,发editor与内部peer reviewer审稿。同时,发SME审阅。
Waterfall流程下,通常集成测试结束后,开始操作文档的外部评审。