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