【经验谈】文档测试策略与流程

导言

收到一位TW新人的问题:该如何去制订适用的文档测试策略,这方面,有什么标准吗?

好问题!文档测试是保证文档正确性与完整性(Easy to Use)的关键一环。对于文档测试的标准,我没注意到业内出过相关国际国内标准。不过,我很乐意根据以往的工作经验,总结一下我对文档评审与测试方法与策略的心得。

评审类别

对于操作类手册,评审通常分两块:

  • 外部评审:由测试工程师(有时会是开发工程师)与产品经理对文档进行评审

有条件时请SME对文档进行综合评测。比如在穆迪时,穆迪产品管理部门有一个由资深银行从业人员组成的SME组。他们会从用户的角度对文档进行评审,为操作手册提供不少实用的案例,加深用户对产品应用场景的理解。这些案例的加入,大大提高了文档的可读性与专业性。

  • 组内内审:组内同事互审+ Editorial Review

以我的经验,组内内事互审这一环节对提升文档内容的正确性与一致,发现文档写作规范的作用特别大。

评审要点

  1. 操作步骤是否正确无误;链接是否有效;
  2. 功能有无遗漏;
  3. 对概念性问题的阐述与理解是否正确;
  4. 概念阐述是否正确反映产品设计意图;
  5. 表达是否通顺正确;
  6. 文档组织结构是否合理;
  7. 文法是否遵循公司写作规范;
  8. 从近“小白”的角度,考查易懂性、逻辑合理性、文字简洁清晰性

角色侧重点

  • 产品经理:2、3、4、5、6
  • 测试人员:1、2、3、5、6
  • 内审:5、6、7、8

Tip: 对于评审意见的采纳,TW必须要有自己的坚持。比如,在写作时,TW会把一个feature(功能)包装成一个与用户日常操作Task, 但测试的评审出发点是:功能;有时不能领会TW的苦心。这时,TW要与测试进行沟通,据理力争,正确的立场就必须坚持。

文档评审流程

我的经验:Waterfall与Agile流程下评审流程有所不同。
对于操作手册,(此处放流程图为佳)Agile开发模式下:

  1. Iteration 1开发结束后(也即第二个iteration开始),开始iteration 1文档开发;
  2. 当iteration 2开发结束时,完成iteration 1的内容开发。将文档发给QA(测试)与给产品经理(PM)测试评审。然后,TW根据意见修订文档。
  3. 如此往复至所有iteration结束。
  4. 文档整体定稿,发给QA与PM全文复审。之后,TW根据复审意见修订文档。
  5. 定稿后,内审开始,发editor与内部peer reviewer审稿。同时,发SME审阅。

Waterfall流程下,通常集成测试结束后,开始操作文档的外部评审。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345