關(guān)鍵字：bug report

你有沒(méi)有為了要更多的信息而被返回bug report的經(jīng)歷呢？有沒(méi)有碰到過(guò)你發(fā)現(xiàn)的一個(gè)非常嚴(yán)重的錯(cuò)誤被推遲到下一個(gè)版本才去修復(fù)的情況呢？

你提交的每一個(gè)bug report都是和項(xiàng)目組正在測(cè)試中的軟件質(zhì)量問(wèn)題的一種書(shū)面溝通方式。通常，你用于溝通程序錯(cuò)誤的能力－不是體現(xiàn)在錯(cuò)誤本身的內(nèi)在嚴(yán)重程度－而是體現(xiàn)在確定這個(gè)錯(cuò)誤是否需要修復(fù)。

如果這是一個(gè)可怕的想法，你可能會(huì)想，“等等！我討厭寫(xiě)作，我并不擅長(zhǎng)寫(xiě)作。怎么樣才能夠通過(guò)編寫(xiě)bug report來(lái)決定錯(cuò)誤的命運(yùn)呢？”它要吸引大家相信錯(cuò)誤是為他們說(shuō)話的－任何一個(gè)頭腦正常的人都應(yīng)該主動(dòng)地查看一個(gè)特定的錯(cuò)誤是足夠可怕的以致要被修復(fù)。不幸的是，事實(shí)并不是這樣。

但是好消息是：有效的和軟件開(kāi)發(fā)人員、項(xiàng)目組溝通的能力不是由你在高校英語(yǔ)課程中的表現(xiàn)所決定的。

這不是關(guān)于用有趣的詞語(yǔ)編寫(xiě)流暢散文，也不是關(guān)于語(yǔ)法和拼寫(xiě)的方法。它是有關(guān)僅用能夠表達(dá)你觀點(diǎn)的詞語(yǔ)明白地表述錯(cuò)誤的方法。太多地話將會(huì)使你的觀點(diǎn)陷入茫然無(wú)措中。太少地話又會(huì)使他人用自己的假設(shè)去填補(bǔ)隔閡－通常是對(duì)軟件有害的部分。如果你不是很確信是什么樣的錯(cuò)誤，那么不管你的bug report寫(xiě)得怎么好，也沒(méi)有人知道那是什么樣的錯(cuò)誤。

這篇文章主要討論你現(xiàn)在能夠開(kāi)始著手提高人們傾聽(tīng)你發(fā)現(xiàn)的錯(cuò)誤的機(jī)會(huì)的4個(gè)方法。

了解你的聽(tīng)眾
毋庸置疑，任何寫(xiě)作課都會(huì)告訴你必須了解你是為誰(shuí)編寫(xiě)bug report。

每份bug report至少有兩個(gè)聽(tīng)眾：必須要修復(fù)錯(cuò)誤的人和決定錯(cuò)誤命運(yùn)的人或團(tuán)體。有時(shí)一個(gè)人會(huì)同時(shí)負(fù)責(zé)這兩份工作，但是仍然是兩個(gè)不同的聽(tīng)眾，只是一起發(fā)生在同一個(gè)人身上罷了。

你的第一個(gè)聽(tīng)眾－那個(gè)必須修復(fù)錯(cuò)誤的人需要清楚，明確的步驟以重現(xiàn)錯(cuò)誤。信息越多越好。針對(duì)這個(gè)目的，我們稱這個(gè)人為“開(kāi)發(fā)人員”。開(kāi)發(fā)人員需要關(guān)于我們操作了什么和我們看見(jiàn)了什么的準(zhǔn)確信息。

你的第二個(gè)聽(tīng)眾－決定錯(cuò)誤命運(yùn)的人或團(tuán)體需要知道如果不修復(fù)此錯(cuò)誤的后果。這個(gè)聽(tīng)眾需要精練的語(yǔ)句以抓住他們的注意力并且引發(fā)對(duì)錯(cuò)誤的相關(guān)連問(wèn)題的討論。基于這個(gè)目的，我們稱他為“錯(cuò)誤審核委員會(huì)”。在使錯(cuò)誤得以修復(fù)的過(guò)程中你的角色是幫助錯(cuò)誤審核委員會(huì)了解不修復(fù)錯(cuò)誤的風(fēng)險(xiǎn)遠(yuǎn)遠(yuǎn)超過(guò)修復(fù)錯(cuò)誤可能發(fā)生的風(fēng)險(xiǎn)。

你越了解你的開(kāi)發(fā)人員和錯(cuò)誤審核委員會(huì)如何工作，你越可以根據(jù)他們的需要裁減你的bug report。盡力在私底下設(shè)法了解你的聽(tīng)眾。如果你能夠出席錯(cuò)誤審核委員會(huì)會(huì)議，嘗試這樣做。你將學(xué)習(xí)到許多關(guān)于你的聽(tīng)眾是如何思考的知識(shí)。

選擇一個(gè)好的標(biāo)題
一般把用于描述錯(cuò)誤的短句稱為錯(cuò)誤的標(biāo)題或描述。這是bug report中重要的部分。錯(cuò)誤審核委員會(huì)成員經(jīng)常通過(guò)它來(lái)決定錯(cuò)誤是否可以推遲修復(fù)。如果標(biāo)題沒(méi)有力度，委員會(huì)成員可能認(rèn)為它是不值得花費(fèi)太多的時(shí)間。（畢竟，在接下來(lái)的2個(gè)小時(shí)里還有145個(gè)以上的錯(cuò)誤要審核。）

以下是一些示例：

好的：超時(shí)后在退出時(shí)崩潰了

太長(zhǎng)的：在數(shù)據(jù)庫(kù)不可用后你又保存記錄的更改，然后從文件菜單中選擇退出時(shí)程序崩潰了

不足夠的信息：程序崩潰了

太模糊：當(dāng)數(shù)據(jù)庫(kù)離線時(shí)出現(xiàn)問(wèn)題

標(biāo)題變成了一種給項(xiàng)目組提供檢查和調(diào)查錯(cuò)誤的方法。和數(shù)據(jù)相比，人們更容易記詞語(yǔ)。人們更愿意記得“在windows2000下不能夠安裝”的錯(cuò)誤，而不是類似“＃23423”錯(cuò)誤，而且在以后人們還會(huì)利用這些關(guān)鍵詞搜索錯(cuò)誤。

編寫(xiě)一個(gè)好的，簡(jiǎn)明的錯(cuò)誤標(biāo)題是不容易的。和編寫(xiě)bug report的其他部分相比，應(yīng)該多花些時(shí)間構(gòu)造理想的錯(cuò)誤標(biāo)題。要確信標(biāo)題是足夠短以便能夠在顯示錯(cuò)誤的屏幕上和由缺陷跟蹤系統(tǒng)生成的報(bào)表中顯示完全（不會(huì)折行）。標(biāo)題不必是完美的語(yǔ)法，而應(yīng)簡(jiǎn)短并一針見(jiàn)血。

書(shū)寫(xiě)清楚，明確的步驟
你提交給開(kāi)發(fā)人員的步驟應(yīng)該提供如何產(chǎn)生錯(cuò)誤的信息，這樣錯(cuò)誤能夠被發(fā)現(xiàn)并且修復(fù)。它也需要給錯(cuò)誤審核委員會(huì)提供錯(cuò)誤發(fā)生的環(huán)境。

正確：

1．運(yùn)行客戶端

2．找出一個(gè)記錄

3．更改記錄但不存盤(pán)

4．使數(shù)據(jù)庫(kù)服務(wù)器脫機(jī)

5．嘗試保存記錄

6．收到一個(gè)超時(shí)的錯(cuò)誤

7．退出客戶端