如何寫(xiě)出一個(gè)高質(zhì)量的缺陷報(bào)告

1.為什么要寫(xiě)缺陷報(bào)告

當(dāng)我們發(fā)現(xiàn)Bug后梧宫,需要通知開(kāi)發(fā)人員,缺陷報(bào)告是一種溝通的介質(zhì)杭攻,它的主要目的是讓開(kāi)發(fā)人員能夠親眼看到這個(gè)Bug是什么祟敛,如果不提供足夠詳細(xì)的說(shuō)明來(lái)幫助開(kāi)發(fā)人員重現(xiàn)Bug,那么他們就沒(méi)法確定問(wèn)題的根源兆解。缺陷報(bào)告是一種用來(lái)說(shuō)明期望結(jié)果和實(shí)際結(jié)果之間的差異以及描述bug如何重現(xiàn)的文檔。發(fā)現(xiàn)Bug,最好是一發(fā)現(xiàn)并確認(rèn)了bug就立即填寫(xiě)缺陷報(bào)告跑揉,而不要等到當(dāng)天測(cè)試結(jié)束再和其他bug一起填锅睛,因?yàn)槟菚r(shí)就有可能遺漏一些要點(diǎn),甚至是遺漏某個(gè)bug历谍∠志埽花點(diǎn)時(shí)間分析一下造成Bug的根本原因是什么,你可能會(huì)因此發(fā)現(xiàn)更多的Bug望侈,最好能把你的任何有用的證據(jù)都寫(xiě)到缺陷報(bào)告上印蔬。缺陷報(bào)告提交之前自己再讀一遍,可能會(huì)有錯(cuò)別字或者什么寫(xiě)錯(cuò)的地方需要重寫(xiě)脱衙。

2.填寫(xiě)缺陷報(bào)告時(shí)應(yīng)注意的幾個(gè)地方

2.1標(biāo)題

缺陷報(bào)告的“標(biāo)題”部分是一個(gè)缺陷報(bào)告帶給讀者的最初印象侥猬,它在瀏覽大量Bug時(shí)起著非常重要的作用例驹,每個(gè)缺陷報(bào)告都應(yīng)該有一個(gè)能夠突出重點(diǎn)的“標(biāo)題”,就好像做廣告一樣退唠。好的標(biāo)題應(yīng)該控制在措辭鹃锈,要據(jù)實(shí)反應(yīng)情況,不要夸大或縮小Bug的影響瞧预。有時(shí)候會(huì)發(fā)現(xiàn)一些令人不可思議的低級(jí)Bug屎债,但還是要盡量使用較為委婉的詞語(yǔ)來(lái)表述,免得傷害開(kāi)發(fā)人員的自尊心垢油。

2.2描述

描述越簡(jiǎn)單直接越好盆驹,要考慮到目標(biāo)讀者,他們可能是開(kāi)發(fā)人員滩愁、測(cè)試人員躯喇、管理人員或者其他人,所以要讓目標(biāo)讀者都能看得懂Bug描述惊楼。

2.3重現(xiàn)的步驟

每一步以及所有步驟組合起來(lái)應(yīng)該是符合邏輯的玖瘸。清晰地列出所需的前置條件。

步驟應(yīng)盡量詳細(xì)檀咙,例如雅倒,我們要描述通過(guò)excel保存一個(gè)表格,那么有兩種方式弧可,一是說(shuō)得細(xì)點(diǎn)兒蔑匣,即“從[表格]菜單里單擊[保存],另一種就是說(shuō)得簡(jiǎn)單點(diǎn)棕诵,即“保存表格”裁良,但請(qǐng)記住,并非所有人都知道如何從excel保存表格校套,或者說(shuō)所有人都會(huì)使用同樣的方式保存表格价脾,所以描述的時(shí)候最好還是采用第一種方式。寫(xiě)完之后自己用新的測(cè)試數(shù)據(jù)或者在新的系統(tǒng)上按照步驟親自執(zhí)行一遍笛匙,或許能夠發(fā)現(xiàn)缺陷報(bào)告里有一些是遺漏的或多余的步驟侨把。

2.4測(cè)試數(shù)據(jù)

開(kāi)發(fā)人員重現(xiàn)Bug時(shí)可能不會(huì)訪問(wèn)測(cè)試環(huán)境,有些Bug可能只能用一定的測(cè)試數(shù)據(jù)才能重現(xiàn)妹孙,所以盡量把測(cè)試數(shù)據(jù)附在缺陷報(bào)告上秋柄。

2.5屏幕截圖

屏幕截圖是缺陷報(bào)告里非常重要的組成部分,有時(shí)一張圖能勝過(guò)千言萬(wàn)語(yǔ)蠢正,但也不能養(yǎng)成習(xí)慣不管有用沒(méi)用的圖都往上貼骇笔,或者是只貼圖而缺少文字描述。附圖能夠使開(kāi)發(fā)人員結(jié)合你的描述快速地重現(xiàn)Bug是最理想的:所附圖片的尺寸和占用空間不要太大,盡量用jpg或gif格式笨触,而不要用bmp格式懦傍。在圖中出問(wèn)題的地方標(biāo)注一下,更利于開(kāi)發(fā)人員快速定位旭旭。

2.6嚴(yán)重程度/優(yōu)先級(jí)

設(shè)置Bug的嚴(yán)重程度之前谎脯,應(yīng)該全面地分析Bug的影響,如果我們認(rèn)為這個(gè)Bug的優(yōu)先級(jí)很高持寄,那么應(yīng)該在缺陷報(bào)告里說(shuō)明優(yōu)先級(jí)高的原因源梭。

2.7日志

如果可以的話一定要把程序報(bào)錯(cuò)的日志附上,這會(huì)讓開(kāi)發(fā)人員比較容易進(jìn)行分析和調(diào)試稍味。很多不能重現(xiàn)的Bug都是因?yàn)槿鄙偃罩痉下椋_(kāi)發(fā)人員就會(huì)返回去找測(cè)試人員要日志信息。如果日志文件不大的話模庐,比如十幾行烛愧,那么可以直接把日志信息粘到缺陷報(bào)告里,如果日志很大的話掂碱,那么最好單獨(dú)粘到一個(gè)文件里怜姿,然后當(dāng)作缺陷報(bào)告的附件就可以了。

【原創(chuàng)文章? 轉(zhuǎn)載請(qǐng)標(biāo)注此出處】

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末疼燥,一起剝皮案震驚了整個(gè)濱河市沧卢,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌醉者,老刑警劉巖但狭,帶你破解...
    沈念sama閱讀 218,755評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異撬即,居然都是意外死亡立磁,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)剥槐,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)唱歧,“玉大人,你說(shuō)我怎么就攤上這事粒竖÷鹾恚” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,138評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵温圆,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我孩革,道長(zhǎng)岁歉,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,791評(píng)論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮锅移,結(jié)果婚禮上熔掺,老公的妹妹穿的比我還像新娘。我一直安慰自己非剃,他們只是感情好置逻,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著备绽,像睡著了一般券坞。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上肺素,一...
    開(kāi)封第一講書(shū)人閱讀 51,631評(píng)論 1 305
  • 那天恨锚,我揣著相機(jī)與錄音,去河邊找鬼倍靡。 笑死猴伶,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的塌西。 我是一名探鬼主播他挎,決...
    沈念sama閱讀 40,362評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼捡需!你這毒婦竟也來(lái)了办桨?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,264評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤栖忠,失蹤者是張志新(化名)和其女友劉穎崔挖,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體庵寞,經(jīng)...
    沈念sama閱讀 45,724評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡狸相,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了捐川。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片脓鹃。...
    茶點(diǎn)故事閱讀 40,040評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖古沥,靈堂內(nèi)的尸體忽然破棺而出瘸右,到底是詐尸還是另有隱情,我是刑警寧澤岩齿,帶...
    沈念sama閱讀 35,742評(píng)論 5 346
  • 正文 年R本政府宣布太颤,位于F島的核電站,受9級(jí)特大地震影響盹沈,放射性物質(zhì)發(fā)生泄漏龄章。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評(píng)論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望做裙。 院中可真熱鬧岗憋,春花似錦、人聲如沸锚贱。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,944評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)拧廊。三九已至监徘,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間卦绣,已是汗流浹背耐量。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,060評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留滤港,地道東北人廊蜒。 一個(gè)月前我還...
    沈念sama閱讀 48,247評(píng)論 3 371
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像溅漾,于是被迫代替她去往敵國(guó)和親山叮。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容

  • -----轉(zhuǎn)載----- 1添履、問(wèn):你在測(cè)試中發(fā)現(xiàn)了一個(gè)bug屁倔,但是開(kāi)發(fā)經(jīng)理認(rèn)為這不是一個(gè)bug,你應(yīng)該怎樣解決暮胧? ...
    花開(kāi)沉浮閱讀 7,385評(píng)論 4 88
  • 1锐借、問(wèn):你在測(cè)試中發(fā)現(xiàn)了一個(gè)bug,但是開(kāi)發(fā)經(jīng)理認(rèn)為這不是一個(gè)bug往衷,你應(yīng)該怎樣解決钞翔? 首先,將問(wèn)題提交到缺陷管理...
    小灰輝先生閱讀 1,335評(píng)論 0 3
  • 1****席舍、問(wèn):你在測(cè)試中發(fā)現(xiàn)了一個(gè)bug****布轿,但是開(kāi)發(fā)經(jīng)理認(rèn)為這不是一個(gè)bug****,你應(yīng)該怎樣解決来颤?首先...
    一箭閱讀 9,073評(píng)論 1 205
  • 如何寫(xiě)出高質(zhì)量的Bug單 程序員是否經(jīng)常讓你在Bug單上再提供一些更多的信息汰扭?當(dāng)Bug單提交后,你是否經(jīng)常會(huì)再花很...
    蘋(píng)果柳橙不加冰閱讀 1,887評(píng)論 0 5
  • 缺陷管理 缺陷管理問(wèn)題的引出 The First “Computer Bug” | 首個(gè)“計(jì)算機(jī)Bug” Moth...
    厲鉚兄閱讀 3,029評(píng)論 0 6