導(dǎo)言
收到一位TW新人的問題：該如何去制訂適用的文檔測(cè)試策略，這方面，有什么標(biāo)準(zhǔn)嗎晶密？
好問題！文檔測(cè)試是保證文檔正確性與完整性（Easy to Use）的關(guān)鍵一環(huán)模她。對(duì)于文檔測(cè)試的標(biāo)準(zhǔn)稻艰，我沒注意到業(yè)內(nèi)出過相關(guān)國際國內(nèi)標(biāo)準(zhǔn)。不過侈净，我很樂意根據(jù)以往的工作經(jīng)驗(yàn)尊勿，總結(jié)一下我對(duì)文檔評(píng)審與測(cè)試方法與策略的心得僧凤。
評(píng)審類別
對(duì)于操作類手冊(cè)，評(píng)審?fù)ǔ７謨蓧K：
- 外部評(píng)審：由測(cè)試工程師（有時(shí)會(huì)是開發(fā)工程師）與產(chǎn)品經(jīng)理對(duì)文檔進(jìn)行評(píng)審
有條件時(shí)請(qǐng)SME對(duì)文檔進(jìn)行綜合評(píng)測(cè)元扔。比如在穆迪時(shí)躯保，穆迪產(chǎn)品管理部門有一個(gè)由資深銀行從業(yè)人員組成的SME組。他們會(huì)從用戶的角度對(duì)文檔進(jìn)行評(píng)審澎语，為操作手冊(cè)提供不少實(shí)用的案例途事，加深用戶對(duì)產(chǎn)品應(yīng)用場(chǎng)景的理解。這些案例的加入擅羞，大大提高了文檔的可讀性與專業(yè)性盯孙。
- 組內(nèi)內(nèi)審：組內(nèi)同事互審+ Editorial Review
以我的經(jīng)驗(yàn)，組內(nèi)內(nèi)事互審這一環(huán)節(jié)對(duì)提升文檔內(nèi)容的正確性與一致祟滴，發(fā)現(xiàn)文檔寫作規(guī)范的作用特別大振惰。
評(píng)審要點(diǎn)
- 操作步驟是否正確無誤；鏈接是否有效垄懂；
- 功能有無遺漏骑晶；
- 對(duì)概念性問題的闡述與理解是否正確；
- 概念闡述是否正確反映產(chǎn)品設(shè)計(jì)意圖草慧；
- 表達(dá)是否通順正確桶蛔；
- 文檔組織結(jié)構(gòu)是否合理;
- 文法是否遵循公司寫作規(guī)范；
- 從近“小白”的角度漫谷，考查易懂性仔雷、邏輯合理性、文字簡潔清晰性
角色側(cè)重點(diǎn)
- 產(chǎn)品經(jīng)理：2舔示、3碟婆、4、5惕稻、6
- 測(cè)試人員：1竖共、2、3俺祠、5公给、6
- 內(nèi)審：5、6蜘渣、7淌铐、8
Tip: 對(duì)于評(píng)審意見的采納，TW必須要有自己的堅(jiān)持蔫缸。比如腿准，在寫作時(shí)，TW會(huì)把一個(gè)feature（功能）包裝成一個(gè)與用戶日常操作Task, 但測(cè)試的評(píng)審出發(fā)點(diǎn)是：功能捂龄；有時(shí)不能領(lǐng)會(huì)TW的苦心释涛。這時(shí)加叁，TW要與測(cè)試進(jìn)行溝通唇撬，據(jù)理力爭，正確的立場(chǎng)就必須堅(jiān)持展融。
文檔評(píng)審流程
我的經(jīng)驗(yàn)：Waterfall與Agile流程下評(píng)審流程有所不同窖认。
對(duì)于操作手冊(cè)，（此處放流程圖為佳）Agile開發(fā)模式下：
- Iteration 1開發(fā)結(jié)束后(也即第二個(gè)iteration開始）告希，開始iteration 1文檔開發(fā)扑浸；
- 當(dāng)iteration 2開發(fā)結(jié)束時(shí)，完成iteration 1的內(nèi)容開發(fā)燕偶。將文檔發(fā)給QA(測(cè)試）與給產(chǎn)品經(jīng)理(PM)測(cè)試評(píng)審喝噪。然后，TW根據(jù)意見修訂文檔指么。
- 如此往復(fù)至所有iteration結(jié)束酝惧。
- 文檔整體定稿，發(fā)給QA與PM全文復(fù)審伯诬。之后晚唇，TW根據(jù)復(fù)審意見修訂文檔。
- 定稿后盗似，內(nèi)審開始哩陕，發(fā)editor與內(nèi)部peer reviewer審稿。同時(shí)赫舒，發(fā)SME審閱悍及。
Waterfall流程下，通常集成測(cè)試結(jié)束后接癌，開始操作文檔的外部評(píng)審并鸵。
