[ English | Português | 簡(jiǎn)體中文 | Česky | Dansk | Deutsch | Français | Polski | Русский | 繁體中文 ]
為公眾寫(xiě)過(guò)軟件的人，大概都收到過(guò)很拙劣的bug（計算機程序代碼中的錯誤或程序運行時(shí)的瑕疵——譯者注）報告，例如：
在報告中說(shuō)“不好用”；
所報告內容毫無(wú)意義；
在報告中用戶(hù)沒(méi)有提供足夠的信息；
在報告中提供了錯誤信息；
所報告的問(wèn)題是由于用戶(hù)的過(guò)失而產(chǎn)生的；
所報告的問(wèn)題是由于其他程序的錯誤而產(chǎn)生的；
所報告的問(wèn)題是由于網(wǎng)絡(luò )錯誤而產(chǎn)生的；
這便是為什么“技術(shù)支持”被認為是一件可怕的工作，因為有拙劣的bug報告需要處理。然而并不是所有的bug報告都令人生厭：我在業(yè)余時(shí)間維護自由軟件，有時(shí)我會(huì )收到非常清晰、有幫助并且“有內容”的bug報告。
在這里我會(huì )盡力闡明如何寫(xiě)一個(gè)好的bug報告。我非常希望每一個(gè)人在報告bug之前都讀一下這篇短文，當然我也希望用戶(hù)在給我報告bug之前已經(jīng)讀過(guò)這篇文章。
簡(jiǎn)單地說(shuō)，報告bug的目的是為了讓程序員看到程序的錯誤。您可以親自示范，也可以給出能導致程序出錯的、詳盡的操作步驟。如果程序出錯了，程序員會(huì )收集額外的信息直到找到錯誤的原因；如果程序沒(méi)有出錯，那么他們會(huì )請您繼續關(guān)注這個(gè)問(wèn)題，收集相關(guān)的信息。
在bug報告里，要設法搞清什么是事實(shí)（例如：“我在電腦旁”和“XX出現了”）什么是推測（例如：“我想問(wèn)題可能是出在……”）。如果愿意的話(huà)，您可以省去推測，但是千萬(wàn)別省略事實(shí)。
當您報告bug的時(shí)候（既然您已經(jīng)這么做了），一定是希望bug得到及時(shí)修正。所以此時(shí)針對程序員的任何過(guò)激或褻瀆的言語(yǔ)（甚至謾罵）都是與事無(wú)補的——因為這可能是程序員的錯誤，也有可能是您的錯誤，也許您有權對他們發(fā)火，但是如果您能多提供一些有用的信息（而不是激憤之詞）或許bug會(huì )被更快的修正。除此以外，請記?。喝绻敲赓M軟件，作者提供給我們已經(jīng)是出于好心，所以要是太多的人對他們無(wú)禮，他們可能就要“收起”這份好心了。
程序員不是弱智：如果程序一點(diǎn)都不好用，他們不可能不知道。他們不知道一定是因為程序在他們看來(lái)工作得很正常。所以，或者是您作過(guò)一些與他們不同的操作，或者是您的環(huán)境與他們不同。他們需要信息，報告bug也是為了提供信息。信息總是越多越好。
許多程序，特別是自由軟件，會(huì )公布一個(gè)“已知bug列表”。如果您找到的bug在列表里已經(jīng)有了，那就不必再報告了，但是如果您認為自己掌握的信息比列表中的豐富，那無(wú)論如何也要與程序員聯(lián)系。您提供的信息可能會(huì )使他們更簡(jiǎn)單地修復bug。
本文中提到的都是一些指導方針，沒(méi)有哪一條是必須恪守的準則。不同的程序員會(huì )喜歡不同形式的bug報告。如果程序附帶了一套報告bug的準則，一定要讀。如果它與本文中提到的規則相抵觸，那么請以它為準。
如果您不是報告bug，而是尋求幫助，您應該說(shuō)明您曾經(jīng)到哪里找過(guò)答案，（例如：我看了第四章和第五章的第二節，但我找不到解決的辦法。）這會(huì )使程序員了解用戶(hù)喜歡到哪里去找答案，從而使程序員把幫助文檔做得更容易使用。
報告bug的最好的方法之一是“演示”給程序員看。讓程序員站在電腦前，運行他們的程序，指出程序的錯誤。讓他們看著(zhù)您啟動(dòng)電腦、運行程序、如何進(jìn)行操作以及程序對您的輸入有何反應。
他們對自己寫(xiě)的軟件了如指掌，他們知道哪些地方不會(huì )出問(wèn)題，而哪些地方最可能出問(wèn)題。他們本能地知道應該注意什么。在程序真的出錯之前，他們可能已經(jīng)注意到某些地方不對勁，這些都會(huì )給他們一些線(xiàn)索。他們會(huì )觀(guān)察程序測試中的每一個(gè)細節，并且選出他們認為有用的信息。
這些可能還不夠。也許他們覺(jué)得還需要更多的信息，會(huì )請您重復剛才的操作。他們可能在這期間需要與您交流一下，以便在他們需要的時(shí)候讓bug重新出現。他們可能會(huì )改變一些操作，看看這個(gè)錯誤的產(chǎn)生是個(gè)別問(wèn)題還是相關(guān)的一類(lèi)問(wèn)題。如果您不走運，他們可能需要坐下來(lái)，拿出一堆開(kāi)發(fā)工具，花上幾個(gè)小時(shí)來(lái)好好地研究一下。但是最重要的是在程序出錯的時(shí)候讓程序員在電腦旁。一旦他們看到了問(wèn)題，他們通常會(huì )找到原因并開(kāi)始試著(zhù)修改。
如今是網(wǎng)絡(luò )時(shí)代，是信息交流的時(shí)代。我可以點(diǎn)一下鼠標把自己的程序送到俄羅斯的某個(gè)朋友那里，當然他也可以用同樣簡(jiǎn)單的方法給我一些建議。但是如果我的程序出了什么問(wèn)題，我不可能在他旁邊。“演示”是很好的辦法，但是常常做不到。
如果您必須報告bug，而此時(shí)程序員又不在您身邊，那么您就要想辦法讓bug重現在他們面前。當他們親眼看到錯誤時(shí)，就能夠進(jìn)行處理了。
確切地告訴程序員您做了些什么。如果是一個(gè)圖形界面程序，告訴他們您按了哪個(gè)按鈕，依照什么順序按的。如果是一個(gè)命令行程序，精確的告訴他們您鍵入了什么命令。您應該盡可能詳細地提供您所鍵入的命令和程序的反應。
把您能想到的所有的輸入方式都告訴程序員，如果程序要讀取一個(gè)文件，您可能需要發(fā)一個(gè)文件的拷貝給他們。如果程序需要通過(guò)網(wǎng)絡(luò )與另一臺電腦通訊，您或許不能把那臺電腦復制過(guò)去，但至少可以說(shuō)一下電腦的類(lèi)型和安裝了哪些軟件（如果可以的話(huà)）。
如果您給了程序員一長(cháng)串輸入和指令，他們執行以后沒(méi)有出現錯誤，那是因為您沒(méi)有給他們足夠的信息，可能錯誤不是在每臺計算機上都出現，您的系統可能和他們的在某些地方不一樣。有時(shí)候程序的行為可能和您預想的不一樣，這也許是誤會(huì )，但是您會(huì )認為程序出錯了，程序員卻認為這是對的。
同樣也要描述發(fā)生了什么。精確的描述您看到了什么。告訴他們?yōu)槭裁茨X(jué)得自己所看到的是錯誤的，最好再告訴他們，您認為自己應該看到什么。如果您只是說(shuō)：“程序出錯了”，那您很可能漏掉了非常重要的信息。
如果您看到了錯誤消息，一定要仔細、準確的告訴程序員，這確實(shí)很重要。在這種情況下，程序員只要修正錯誤，而不用去找錯誤。他們需要知道是什么出問(wèn)題了，系統所報的錯誤消息正好幫助了他們。如果您沒(méi)有更好的方法記住這些消息，就把它們寫(xiě)下來(lái)。只報告“程序出了一個(gè)錯”是毫無(wú)意義的，除非您把錯誤消息一塊報上來(lái)。
特殊情況下，如果有錯誤消息號，一定要把這些號碼告訴程序員。不要以為您看不出任何意義，它就沒(méi)有意義。錯誤消息號包含了能被程序員讀懂的各種信息，并且很有可能包含重要的線(xiàn)索。給錯誤消息編號是因為用語(yǔ)言描述計算機錯誤常常令人費解。用這種方式告訴您錯誤的所在是一個(gè)最好的辦法。
在這種情形下，程序員的排錯工作會(huì )十分高效。他們不知道發(fā)生了什么，也不可能到現場(chǎng)去觀(guān)察，所以他們一直在搜尋有價(jià)值的線(xiàn)索。錯誤消息、錯誤消息號以及一些莫名其妙的延遲，都是很重要的線(xiàn)索，就像辦案時(shí)的指紋一樣重要，保存好。
如果您使用UNIX系統，程序可能會(huì )產(chǎn)生一個(gè)內核輸出（coredump）。內核輸出是特別有用的線(xiàn)索來(lái)源，別扔了它們。另一方面，大多數程序員不喜歡收到含有大量?jì)群溯敵鑫募腅MAIL，所以在發(fā)郵件之前最好先問(wèn)一下。還有一點(diǎn)要注意：內核輸出文件記錄了完整的程序狀態(tài)，也就是說(shuō)任何秘密（可能當時(shí)程序正在處理一些私人信息或秘密數據）都可能包含在內核輸出文件里。
當一個(gè)錯誤或bug發(fā)生的時(shí)候，您可能會(huì )做許多事情。但是大多數人會(huì )使事情變的更糟。我的一個(gè)朋友在學(xué)校里誤刪了她所有的Word文件，在找人幫忙之前她重裝了Word，又運行了一遍碎片整理程序，這些操作對于恢復文件是毫無(wú)益處的，因為這些操作搞亂了磁盤(pán)的文件區塊?？峙略谶@個(gè)世界上沒(méi)有一種反刪除軟件能恢復她的文件了。如果她不做任何操作，或許還有一線(xiàn)希望。
這種用戶(hù)仿佛一只被逼到墻角的鼬（黃鼠狼、紫貂一類(lèi)的動(dòng)物——譯者注）：背靠墻壁，面對死亡的降臨奮起反撲，瘋狂攻擊。他們認為做點(diǎn)什么總比什么都不做強。然而這些在處理計算機軟件問(wèn)題時(shí)并不適用。
不要做鼬，做一只羚羊。當一只羚羊面對料想不到的情況或受到驚嚇時(shí)，它會(huì )一動(dòng)不動(dòng)，是為了不吸引任何注意，與此同時(shí)也在思考解決問(wèn)題的最好辦法（如果羚羊有一條技術(shù)支持熱線(xiàn)，此時(shí)占線(xiàn)。）。然后，一旦它找到了最安全的行動(dòng)方案，它便去做。
當程序出毛病的時(shí)候，立刻停止正在做的任何操作。不要按任何健。仔細地看一下屏幕，注意那些不正常的地方，記住它或者寫(xiě)下來(lái)。然后慎重地點(diǎn)擊“確定” 或“取消”，選擇一個(gè)最安全的。學(xué)著(zhù)養成一種條件反射——一旦電腦出了問(wèn)題，先不要動(dòng)。要想擺脫這個(gè)問(wèn)題，關(guān)掉受影響的程序或者重新啟動(dòng)計算機都不好，一個(gè)解決問(wèn)題的好辦法是讓問(wèn)題再次產(chǎn)生。程序員們喜歡可以被重現的問(wèn)題，快樂(lè )的程序員可以更快而且更有效率的修復bug。
并不只是非專(zhuān)業(yè)的用戶(hù)才會(huì )寫(xiě)出拙劣的bug報告，我見(jiàn)過(guò)一些非常差的bug報告出自程序員之手，有些還是非常優(yōu)秀的程序員。
有一次我與另一個(gè)程序員一起工作，他一直在找代碼中的bug，他常常遇到一個(gè)bug，但是不會(huì )解決，于是就叫我幫忙。“出什么毛病了？”我問(wèn)。而他的回答卻總是一些關(guān)于bug的意見(jiàn)。如果他的觀(guān)點(diǎn)正確，那的確是一件好事。這意味著(zhù)他已經(jīng)完成了工作的一半，并且我們可以一起完成另一半工作。這是有效率并有用的。
但事實(shí)上他常常是錯的。這就會(huì )使我們花上半個(gè)小時(shí)在原本正確的代碼里來(lái)回尋找錯誤，而實(shí)際上問(wèn)題出在別的地方。我敢肯定他不會(huì )對醫生這么做。“大夫，我得了Hydroyoyodyne（真是怪病——譯者），給我開(kāi)個(gè)方子”，人們知道不該對一位醫生說(shuō)這些。您描述一下癥狀，哪個(gè)地方不舒服，哪里疼、起皮疹、發(fā)燒……讓醫生診斷您得了什么病，應該怎樣治療。否則醫生會(huì )把您當做疑心病或精神病患者打發(fā)了，這似乎沒(méi)什么不對。
做程序員也是一樣。即便您自己的“診斷”有時(shí)真的有幫助，也要只說(shuō)“癥狀”。“診斷”是可說(shuō)可不說(shuō)的，但是“癥狀”一定要說(shuō)。同樣，在bug報告里面附上一份針對bug而做出修改的源代碼是有用處的，但它并不能替代bug報告本身。
如果程序員向您詢(xún)問(wèn)額外的信息，千萬(wàn)別應付。曾經(jīng)有一個(gè)人向我報告bug，我讓他試一個(gè)命令，我知道這個(gè)命令不好用，但我是要看看程序會(huì )返回一個(gè)什么錯誤（這是很重要的線(xiàn)索）。但是這位老兄根本就沒(méi)試，他在回復中說(shuō)“那肯定不好用”，于是我又花了好些時(shí)間才說(shuō)服他試了一下那個(gè)命令。
用戶(hù)多動(dòng)動(dòng)腦筋對程序員的工作是有幫助的。即使您的推斷是錯誤的，程序員也應該感謝您，至少您想去幫助他們，使他們的工作變的更簡(jiǎn)單。不過(guò)千萬(wàn)別忘了報告“癥狀”，否則只會(huì )使事情變得更糟。
“間歇性錯誤”著(zhù)實(shí)讓程序員發(fā)愁。相比之下，進(jìn)行一系列簡(jiǎn)單的操作便能導致錯誤發(fā)生的問(wèn)題是簡(jiǎn)單的。程序員可以在一個(gè)便于觀(guān)察的條件下重復那些操作，觀(guān)察每一個(gè)細節。太多的問(wèn)題在這種情況下不能解決，例如：程序每星期出一次錯，或者偶然出一次錯，或者在程序員面前從不出錯（程序員一離開(kāi)就出錯。——譯者）。當然還有就是程序的截止日期到了，那肯定要出錯。
大多數“間歇性錯誤”并不是真正的“間歇”。其中的大多數錯誤與某些地方是有聯(lián)系的。有一些錯誤可能是內存泄漏產(chǎn)生的，有一些可能是別的程序在不恰當的時(shí)候修改某個(gè)重要文件造成的，還有一些可能發(fā)生在每一個(gè)小時(shí)的前半個(gè)小時(shí)中（我確實(shí)遇到過(guò)這種事情）。
同樣，如果您能使bug重現，而程序員不能，那很有可能是他們的計算機和您的計算機在某些地方是不同的，這種不同引起了問(wèn)題。我曾寫(xiě)過(guò)一個(gè)程序，它的窗口可以蜷縮成一個(gè)小球呆在屏幕的左上角，它在別的計算機上只能在 800x600 的解析度工作，但是在我的機器上卻可以在 1024x768 下工作。
程序員想要了解任何與您發(fā)現的問(wèn)題相關(guān)的事情。有可能的話(huà)您到另一臺機器上試試，多試幾次，兩次，三次，看看問(wèn)題是不是經(jīng)常發(fā)生。如果問(wèn)題出現在您進(jìn)行了一系列操作之后，不是您想讓它出現它就會(huì )出現，這就有可能是長(cháng)時(shí)間的運行或處理大文件所導致的錯誤。程序崩潰的時(shí)候，您要盡可能的記住您都做了些什么，并且如果您看到任何圖形,也別忘了提一下。您提供的任何事情都是有幫助的。即使只是概括性的描述（例如：當后臺有EMACS運行時(shí)，程序常常出錯），這雖然不能提供導致問(wèn)題的直接線(xiàn)索，但是可能幫助程序員重現問(wèn)題。
最重要的是：程序員想要確定他們正在處理的是一個(gè)真正的“間歇性錯誤”呢，還是一個(gè)在另一類(lèi)特定的計算機上才出現的錯誤。他們想知道有關(guān)您計算機的許多細節，以便了解您的機器與他們的有什么不同。有許多細節都依仗特定的程序，但是有一件東西您一定要提供——版本號。程序的版本、操作系統的版本以及與問(wèn)題有關(guān)的程序的版本。
表意清楚在一份bug報告里是最基本的要求。如果程序員不知道您說(shuō)的是什么意思，那您就跟沒(méi)說(shuō)一樣。我收到的bug報告來(lái)自世界各地，有許多是來(lái)自非英語(yǔ)國家，他們通常為自己的英文不好而表示歉意?？偟膩?lái)說(shuō)，這些用戶(hù)發(fā)來(lái)的bug報告通常是清晰而且有用的。幾乎所有不清晰的bug報告都是來(lái)自母語(yǔ)是英語(yǔ)的人，他們總是以為只要自己隨便說(shuō)說(shuō)，程序員就能明白。
聲明：我從沒(méi)有真的看見(jiàn)過(guò)鼬和羚羊，我的比喻可能不恰當。
版權所有 Simon Tatham 1999
本文屬于OPL（OpenContent License），請在復制和使用本文時(shí)自覺(jué)遵守OPL。
對本文的任何意見(jiàn)和批評請發(fā)送至：
英文版：anakin@pobox.com
聯(lián)系客服
