如何寫乙個好的缺陷(Defect)報告

2022-07-09 07:57:13 字數 2129 閱讀 4421

編寫缺陷報告是測試人員的日常工作,好的缺陷報告能夠讓開發人員更容易理解,更快速的定位問題;不好的缺陷報告可能會誤導調查方向,增加溝通成本。那麼乙個好的缺陷報告應該包括哪些方面呢?

請看我的mindmap:

1. 首先要做乙個「標題黨」(此標題黨非彼標題黨)。標題一定要清晰簡潔易理解,不應該臃長

2. 盡量字首要規範,例如模板: [product][version]_[feature]_[title],這樣描述會很清晰,也方便查詢

3. 缺陷的標題一定要描述在什麼情況下發生了什麼問題

4. 盡量避免使用人稱(比如you, i等等)

這個標題包含了產品名,版本號,模組,發生了什麼(cannot enter username),什麼情況下(copy/paste enternal string)

描述或總結這個模組可以用來描述標題不能容納的更詳細的內容,它可以包括很多方面,比如相關、歷史版本是否重現、使用者操作等。目的是更清晰詳細的描述缺陷。

這部分用以描述該缺陷對使用者實際應用中的影響。 

用以描述在重現缺陷之前環境、資料或者其他的一些特殊需求。

從使用者角度出發來描述重現步驟,步與步之間不應該有太大的業務跳躍,最好是連貫的。

例如:repro steps:

2. copy username from enternal file

3. paster username to username field of login screen

結果可以分為「期望結果」和「實際結果」,結果可以有多個,也可以穿插在重現步驟之間(比如重現步驟中有多個缺陷的問題)

凡事都有輕重緩急,缺陷也是,需要標明缺陷優先順序和緊急程度,以便開發團隊決定先做還是延後。

當然,大部分的缺陷是可以100%重現的,對於少數缺陷可能很難重現,或者不太容易重現,這就要標明重現的機率,比如50%。往往這種缺陷需要提供詳細的日誌檔案,以便從日誌角度獲取重現或者解決突破口。

變通方案是提供一種繞過當前問題而使用其它的產品功能的一種方式。這樣客戶就可以在缺陷未解決的情況下繼續使用產品。

描述從**角度,該缺陷是如何發生的。能做到這一步的測試人員需要有較高的讀寫**的能力。

用以描述測試環境的配置,比如os,相應產品版本等。

那麼,問題來了!缺陷包括這麼多方面,如果每個缺陷都這麼寫,要耗費多少effort啊!!!(畢竟測試時最忙的!)

個人認為沒有必要每個都這麼寫,畢竟寫缺陷報告對客戶來說沒有value。缺陷報告是缺陷的資訊載體,它存在的意義是用於更好、更清楚的進行開發團隊之間的溝通和以後的回顧,寫到什麼程度還是需要根據實際情況有所取捨。(比如root cause analysis在時間不富裕的情況下可以忽略等)

綜合以上的方面,下邊是乙個模板,希望對大家有所幫助。

title:   [product][version]_[feature]_title

description/summary:

impact:

priority/severity:

critical

frequency:

100%

precondition:

repro steps:

step 1:

step 2:

expected result:

actual result:

step 3:

expected result:

actual result:

root cause analysis:

workaround:

environment:

attchment:

如何寫乙個好的需求文件

1 從使用者角度的編寫 2 使用screen shots 3 用簡單的語言編寫 a 保持簡短的語句,把長的語句分解成多個小的語句。b 避免大篇幅的連續文字,把他們分解成多個小的章節。c 把大塊文字內容分解成,screen shots,重點列表等等。4 小心的使用模板 我發現mrd模板非常有用。他們的...

如何寫乙個好的需求文件

1 從使用者角度的編寫 2 使用screen shots 3 用簡單的語言編寫 a 保持簡短的語句,把長的語句分解成多個小的語句。b 避免大篇幅的連續文字,把他們分解成多個小的章節。c 把大塊文字內容分解成,screen shots,重點列表等等。4 小心的使用模板 我發現mrd模板非常有用。他們的...

如何寫乙個Stack?

1.棧是陣列 2.先進後出 3.出棧 4.入棧 手寫乙個雙向鍊錶 棧 public class stackpopandpush public stackpopandpush int lens 返回元素個數 public intsize 返回陣列長度,容量,棧資料長 private intcapaci...