提問的藝術

真誠的希望那些又困難又期望得到幫助的新手朋友們抽時間看看,問“好的問題”,收穫“好的答案”,這對改善答題人的心情和形成版面氛圍都有好處。

提問之前

在通過電郵、新聞組或者聊天室提出技術問題前,檢查你有沒有做到:

1. 通讀手冊,試着自己找答案。
2. 在FAQ裏找答案(一份維護得好的FAQ可以包羅萬象:)。
3. 在網上搜索(個人推薦google~~~)。
4. 向你身邊精於此道的朋友打聽。

當你提出問題的時候,首先要說明在此之前你幹了些什麼;這將有助於樹立你的形象:你不是一個妄圖不勞而獲的乞討者,不願浪費別人的時間。如果提問者能從答案中學到東西,我們更樂於回答他的問題。

周全的思考,準備好你的問題,草率的發問只能得到草率的回答,或者根本得不到任何答案。越表現出在尋求幫助前爲解決問題付出的努力,你越能得到實質性的幫助。

小心別問錯了問題。如果你的問題基於錯誤的假設,普通***(J. Random Hacker)通常會用無意義的字面解釋來答覆你,心裏想着“蠢問題…”,希望着你會從問題的回答(而非你想得到的答案)中汲取教訓。

決不要自以爲夠資格得到答案,你沒這種資格。畢竟你沒有爲這種服務支付任何報酬。你要自己去“掙”回一個答案,靠提出一個有內涵的,有趣的,有思維激勵作用的問題–一個對社區的經驗有潛在貢獻的問題,而不僅僅是被動的從他人處索要知識–去掙到這個答案。

另一方面,表明你願意在找答案的過程中做點什麼,是一個非常好的開端。“誰能給點提示?”、“我這個例子裏缺了什麼?”以及“我應該檢查什麼地方?”比“請把確切的過程貼出來”更容易得到答覆。因爲你顯得只要有人指點正確的方向,你就有完成它的能力和決心。

怎樣提問
- 謹慎選擇論壇

小心選擇提問的場合。如果象下面描述的那樣,你很可能被忽略掉或者被看作失敗者:

1. 在風馬牛不相及的論壇貼出你的問題
2. 在探討高級技巧的論壇張貼非常初級的問題;反之亦然
3. 在太多的不同新聞組交叉張貼

- 用辭貼切,語法正確,拼寫無誤

我們從經驗中發現,粗心的寫作者通常也是馬虎的思考者(我敢打包票)。 回答粗心大意者的問題很不值得,我們寧願把時間耗在別處。

正確的拼寫,標點符號和大小寫很重要。

更一般的說,如果你的提問寫得象個半文盲,你很有可能被忽視。

如果你在使用非母語的論壇提問,你可以犯點拼寫和語法上的小錯–但決不能在思考上馬虎(沒錯,我們能弄清兩者的分別)。

- 使用含義豐富,描述準確的標題

在郵件列表或者新聞組中,大約50字以內的主題標題是抓住資深專家注意力的黃金時機。別用喋喋不休的“幫幫忙”(更別說“救命啊!!!!!”這樣讓人反感的話)來浪費這個機會。不要妄想用你的痛苦程度來打動我們, 別用空格代替問題的描述,哪怕是極其簡短的描述。

蠢問題: 救命啊!我的膝上機不能正常顯示了!

聰明問題: XFree86 4.1下鼠標光標變形,Fooware MV1005的顯示芯片。

如果你在回覆中提出問題,記得要修改內容標題,表明裏面有一個問題。一個看起來象“Re:測試”或者“Re:新bug”的問題很難引起足夠重視。另外,引用並刪減前文的內容,給新來的讀者留下線索。

- 精確描述,信息量大

1. 謹慎明確的描述症狀。
2. 提供問題發生的環境(機器配置、操作系統、應用程序以及別的什麼)。
3. 說明你在提問前是怎樣去研究和理解這個問題的。
4. 說明你在提問前採取了什麼步驟去解決它。
5. 羅列最近做過什麼可能有影響的硬件、軟件變更。

儘量想象一個***會怎樣反問你,在提問的時候預先給他答案。

Simon Tatham寫過一篇名爲《如何有效的報告Bug》的出色短文。強力推薦你也讀一讀。

- 話不在多

你需要提供精確有效的信息。這並不是要求你簡單的把成噸的出錯代碼或者數據完全轉儲摘錄到你的提問中。如果你有龐大而複雜的測試條件,儘量把它剪裁得越小越好。

這樣做的用處至少有三點。第一,表現出你爲簡化問題付出了努力,這可以使你得到回答的機會增加;第二,簡化問題使你得到有用答案的機會增加;第三,在提煉你的bug報告的過程中,也許你自己就能找出問題所在或作出更正。

- 只說症狀,不說猜想

告訴***們你認爲問題是怎樣引起的沒什麼幫助。(如果你的推斷如此有效,還用向別人求助嗎?),因此要確信你原原本本告訴了他們問題的症狀,不要加進你自己的理解和推論。讓***們來診斷吧。

蠢問題: 我在內核編譯中一次又一次遇到SIG11錯誤,我懷疑某條飛線搭在主板的走線上了,這種情況應該怎樣檢查最好?

聰明問題: 我自制的一套K6/233系統,主板是FIC-PA2007 (VIA Apollo VP2芯片組),256MB Corsair PC133 SDRAM,在內核編譯中頻頻產生SIG11錯誤,從開機20分鐘以後就有這種情況,開機前20分鐘內從沒發生過。重啓也沒有用,但是關機一晚上就又能工作20分鐘。所有內存都換過了,沒有效果。相關部分的典型編譯記錄如下…。

- 按時間順序列出症狀

對找出問題最有幫助的線索,往往就是問題發生前的一系列操作,因此,你的說明應該包含操作步驟,以及電腦的反應,直到問題產生。

如果你的說明很長(超過四個段落),在開頭簡述問題會有所幫助,接下來按時間順序詳述。這樣***們就知道該在你的說明中找什麼。

- 明白你想問什麼

漫無邊際的提問近乎無休無止的時間黑洞。最能給你有用答案的人也正是最忙的人(他們忙是因爲要親自完成大部分工作)。這樣的人對無節制的時間黑洞不太感冒,因此也可以說他們對漫無邊際的提問不大感冒。

如果你明確表述需要回答者做什麼(提供建議,發送一段代碼,檢查你的補丁或是別的),就最有可能得到有用的答案。這會定出一個時間和精力的上限,便於回答者集中精力來幫你,這很奏效。要理解專家們生活的世界,要把專業技能想象爲充裕的資源,而回復的時間則是貧乏的資源。解決你的問題需要的時間越少,越能從忙碌的專家口中掏出答案。

因此,優化問題的結構,儘量減少專家們解決它所需要的時間,會有很大的幫助–這通常和簡化問題有所區別。因此,問“我想更好的理解X,能給點提示嗎?”通常比問“你能解釋一下X嗎?”更好。如果你的代碼不能工作,問問它有什麼地方不對,比要求別人替你修改要明智得多。

- 別問應該自己解決的問題

***們總是善於分辨哪些問題應該由你自己解決;因爲我們中的大多數都曾自己解決這類問題。同樣,這些問題得由你來搞定,你會從中學到東西。你可以要求給點提示,但別要求得到完整的解決方案。

- 去除無意義的疑問

別用無意義的話結束提問,例如“有人能幫我嗎?”或者“有答案嗎?”。首先:如果你對問題的描述不很合適,這樣問更是畫蛇添足。其次:由於這樣問是畫蛇添足,***們會很厭煩你–而且通常會用邏輯上正確的回答來表示他們的蔑視,例如:“沒錯,有人能幫你”或者“不,沒答案”。

- 謙遜絕沒有害處,而且常幫大忙

彬彬有禮,多用“請”和“先道個謝了”。讓大家都知道你對他們花費時間義務提供幫助心存感激。然而,如果你有很多問題無法解決,禮貌將會增加你得到有用答案的機會。

(我們注意到,自從本指南發佈後,從資深***處得到的唯一嚴重缺陷反饋,就是對預先道謝這一條。一些***覺得“先謝了”的言外之意是過後就不會再感謝任何人了。我們的建議是:都道謝。)

- 問題解決後,加個簡短說明

問題解決後,向所有幫助過你的人發個說明,讓他們知道問題是怎樣解決的,並再一次向他們表示感謝。如果問題在新聞組或者郵件列表中引起了廣泛關注,應該在那裏貼一個補充說明。補充說明不必很長或是很深入;簡單的一句“你好,原來是網線出了問題!謝謝大家–Bill”比什麼也不說要強。事實上,除非結論真的很有技術含量,否則簡短可愛的小結比長篇學術論文更好。說明問題是怎樣解決的,但大可不必將解決問題的過程複述一遍。除了表示禮貌和反饋信息以外,這種補充有助於他人在郵件列表/新聞組/論壇中搜索對你有過幫助的完整解決方案,這可能對他們也很有用。最後(至少?),這種補充有助於所有提供過幫助的人從中得到滿足感。如果你自己不是老手或者***,那就相信我們,這種感覺對於那些你向他們求助的導師或者專家而言,是非常重要的。問題久拖未決會讓人灰心;***們渴望看到問題被解決。好人有好報,滿足他們的渴望,你會在下次貼出新問題時嚐到甜頭。

- 還是不懂

如果你不是很理解答案,別立刻要求對方解釋。象你以前試着自己解決問題時那樣(利用手冊,FAQ,網絡,身邊的高手),去理解它。如果你真的需要對方解釋,記得表現出你已經學到了點什麼。比方說,如果我回答你:“看來似乎是zEntry被阻塞了;你應該先清除它。”,然後:一個很糟的後續問題: “zEntry是什麼?” 聰明的問法應該是這樣:“哦~~~我看過幫助了但是隻有-z和-p兩個參數中提到了zEntry而且還都沒有清楚的解釋:<你是指這兩個中的哪一個嗎?還是我看漏了什麼?”

三思而後問
以下是幾個經典蠢問題,以及***在拒絕回答時的心中所想:

問題:我能在哪找到X程序?
問題:我的程序/配置/SQL申明沒有用
問題:我的Windows有問題,你能幫我嗎?
問題:我在安裝Linux(或者X)時有問題,你能幫我嗎?
問題:我怎麼才能破解root帳號/竊取OP特權/讀別人的郵件呢?

提問:我能在哪找到X程序?
回答:就在我找到它的地方啊蠢貨–搜索引擎的那一頭。天吶!還有人不會用Google嗎?

提問:我的程序(配置、SQL申明)沒有用
回答:這不算是問題吧,我對找出你的真正問題沒興趣–如果要我問你二十個問題才找得出來的話–我有更有意思的事要做呢。

在看到這類問題的時候,我的反應通常不外如下三種:

1. 你還有什麼要補充的嗎?
2. 真糟糕,希望你能搞定。
3. 這跟我有什麼鳥相關?

提問:我的Windows有問題,你能幫我嗎?
回答:能啊,扔掉萎軟的垃圾,換Linux吧。

提問:我在安裝Linux(或者X)時有問題,你能幫我嗎?
回答:不能,我只有親自在你的電腦上動手才能找到毛病。還是去找你當地的Linux用戶組尋求手把手的指導吧(你能在這兒找到用戶組的清單)。

提問:我怎麼才能破解root帳號/竊取OP特權/讀別人的郵件呢?
回答:想要這樣做,說明你是個卑鄙小人;想找個***幫你,說明你是個ΘΘΘΘ!

好問題,壞問題
最後,我舉一些例子來說明,怎樣聰明的提問;同一個問題的兩種問法被放在一起,一種是愚蠢的,另一種纔是明智的。

蠢問題:我可以在哪兒找到關於Foonly Flurbamatic的資料?

// 這種問法無非想得到“STFW”這樣的回答。

聰明問題:我用Google搜索過“Foonly Flurbamatic 2600”,但是沒找到有用的結果。誰知道上哪兒去找對這種設備編程的資料?

// 這個問題已經STFW過了,看起來他真的遇到了麻煩。

蠢問題:我從FOO項目找來的源碼沒法編譯。它怎麼這麼爛?

// 他覺得都是別人的錯,這個傲慢自大的傢伙

聰明問題:FOO項目代碼在Nulix 6.2版下無法編譯通過。我讀過了FAQ,但裏面沒有提到跟Nulix有關的問題。這是我編譯過程的記錄,我有什麼做得不對的地方嗎?

// 他講明瞭環境,也讀過了FAQ,還指明瞭錯誤,並且他沒有把問題的責任推到別人頭上,這個傢伙值得留意。

蠢問題:我的主板有問題了,誰來幫我?

// 普通***對這類問題的回答通常是:“好的,還要幫你拍拍背和換尿布嗎?” ,然後按下刪除鍵。

聰明問題:我在S2464主板上試過了X、Y和Z,但沒什麼作用,我又試了A、B和C。請注意當我嘗試C時的奇怪現象。顯然邊帶傳輸中出現了收縮,但結果出人意料。在多處理器主板上引起邊帶泄漏的通常原因是什麼?誰有好主意接下來我該做些什麼測試才能找出問題?

// 這個傢伙,從另一個角度來看,值得去回答他。他表現出瞭解決問題的能力,而不是坐等天上掉答案。

在最後一個問題中,注意“告訴我答案”和“給我啓示,指出我還應該做什麼診斷工作”之間微妙而又重要的區別。事實上,後一個問題源自於2001年8月在 Linux內核郵件列表上的一個真實的提問。我(Eric)就是那個提出問題的人。我在Tyan S2464主板上觀察到了這種無法解釋的鎖定現象,列表成員們提供瞭解決那一問題的重要信息。

通過我的提問方法,我給了大家值得玩味的東西;我讓人們很容易參與並且被吸引進來。我顯示了自己具備和他們同等的能力,邀請他們與我共同探討。我告訴他們我所走過的彎路,以避免他們再浪費時間,這是一種對他人時間價值的尊重。後來,當我向每個人表示感謝,並且讚賞這套程序(指郵件列表中的討論 –譯者注)運作得非常出色的時候,一個Linux內核郵件列(lkml)成員表示,問題得到解決並非由於我是這個列表中的“名人”,而是因爲我用了正確的方式來提問。我們***從某種角度來說是擁有豐富知識但缺乏人情味的傢伙;我相信他是對的,如果我象個乞討者那樣提問,不論我是誰,一定會惹惱某些人或者被他們忽視。他建議我記下這件事,給編寫這個指南的人一些指導。

找不到答案怎麼辦
如果仍得不到答案,請不要以爲我們覺得無法幫助你。有時只是看到你問題的人不知道答案罷了。沒有迴應不代表你被忽視,雖然不可否認這種差別很難區分。

總的說來,簡單的重複張貼問題是個很糟的想法。這將被視爲無意義的喧鬧。

你可以通過其它渠道獲得幫助,這些渠道通常更適合初學者的需要。有許多網上的以及本地的用戶組,由狂熱的軟件愛好者(即使他們可能從沒親自寫過任何軟件)組成。通常人們組建這樣的團體來互相幫助並幫助新手。

另外,你可以向很多商業公司尋求幫助,不論公司大還是小(Red Hat和LinuxCare就是兩個最常見的例子)。別爲要付費才能獲得幫助而感到沮喪!畢竟,假使你的汽車發動機汽缸密封圈爆掉了–完全可能如此– 你還得把它送到修車鋪,並且爲維修付費。就算軟件沒花費你一分錢,你也不能強求技術支持總是免費的。

對大衆化的軟件,就象 Linux之類而言,每個開發者至少會有上萬名用戶。根本不可能由一個人來處理來自上萬名用戶的求助電話。要知道,即使你要爲幫助付費,同你必須購買同類軟件相比,你所付出的也是微不足道的(通常封閉源代碼軟件的技術支持費用比開放源代碼軟件要高得多,且內容也不那麼豐富)。

如何有效地報告 Bug
引言

爲公衆寫過軟件的人,大概都收到過很拙劣的bug(計算機程序代碼中的錯誤或程序運行時的瑕疵——譯者注)報告,例如:

在報告中說“不好用”;
所報告內容毫無意義;
在報告中用戶沒有提供足夠的信息;
在報告中提供了虛假信息;
所報告的問題是由於用戶的過失而產生的;
所報告的問題是由於其他程序的錯誤而產生的;
所報告的問題是由於網絡錯誤而產生的;

這便是爲什麼“技術支持”被認爲是一件可怕的工作,因爲有拙劣的bug報告需要處理。然而並不是所有的bug報告都令人生厭:我在業餘時間維護自由軟件,有時我會收到非常清晰、有幫助並且內容豐富的bug報告。

在這裏我會盡力闡明如何寫一個好的bug報告。我非常希望每一個人在報告bug之前都讀一下這篇短文,當然我也希望用戶在給我報告bug之前已經讀過這篇文章。

簡單地說,報告bug的目的是爲了讓程序員看到程序的錯誤。您可以親自示範,也可以給出能導致程序出錯的、詳盡的操作步驟。如果程序出錯了,程序員會收集額外的信息直到找到錯誤的原因;如果程序沒有出錯,那麼他們會請您繼續關注這個問題,收集相關的信息。

在bug報告裏,要設法搞清什麼是事實(例如:“我在電腦旁”和“XX出現了”)什麼是推測(例如:“我想問題可能是出在……”)。如果願意的話,您可以省去推測,但是千萬別省略事實。

當您報告bug的時候(既然您已經這麼做了),一定是希望bug得到及時修正。所以此時針對程序員的任何過激或褻瀆的言語(甚至謾罵)都是與事無補的 ——因爲這可能是程序員的錯誤,也有可能是您的錯誤,也許您有權對他們發火,但是如果您能多提供一些有用的信息(而不是激憤之詞)或許bug會被更快的修正。除此以外,請記住:如果是免費軟件,作者提供給我們已經是出於好心,所以要是太多的人對他們無禮,他們可能就要“收起”這份好心了。

“程序不好用”

程序員不是弱智:如果程序一點都不好用,他們不可能不知道。他們不知道一定是因爲程序在他們看來工作得很正常。所以,或者是您作過一些與他們不同的操作,或者是您的環境與他們不同。他們需要信息,報告bug也是爲了提供信息。信息總是越多越好。

許多程序,特別是自由軟件,會公佈一個“已知bug列表”。如果您找到的bug在列表裏已經有了,那就不必再報告了,但是如果您認爲自己掌握的信息比列表中的豐富,那無論如何也要與程序員聯繫。您提供的信息可能會使他們更簡單地修復bug。

本文中提到的都是一些指導方針,沒有哪一條是必須恪守的準則。不同的程序員會喜歡不同形式的bug報告。如果程序附帶了一套報告bug的準則,一定要讀。如果它與本文中提到的規則相抵觸,那麼請以它爲準。

如果您不是報告bug,而是尋求幫助,您應該說明您曾經到哪裏找過答案,(例如:我看了第四章和第五章的第二節,但我找不到解決的辦法。)這會使程序員瞭解用戶喜歡到哪裏去找答案,從而使程序員把幫助文檔做得更容易使用。

“演示給我看”

報告bug的最好的方法之一是“演示”給程序員看。讓程序員站在電腦前,運行他們的程序,指出程序的錯誤。讓他們看着您啓動電腦、運行程序、如何進行操作以及程序對您的輸入有何反應。

他們對自己寫的軟件瞭如指掌,他們知道哪些地方不會出問題,而哪些地方最可能出問題。他們本能地知道應該注意什麼。在程序真的出錯之前,他們可能已經注意到某些地方不對勁,這些都會給他們一些線索。他們會觀察程序測試中的每一個細節,並且選出他們認爲有用的信息。

這些可能還不夠。也許他們覺得還需要更多的信息,會請您重複剛纔的操作。他們可能在這期間需要與您交流一下,以便在他們需要的時候讓bug重新出現。他們可能會改變一些操作,看看這個錯誤的產生是個別問題還是相關的一類問題。如果您不走運,他們可能需要坐下來,拿出一堆開發工具,花上幾個小時研究。但是最重要的是在程序出錯的時候讓程序員在電腦旁。一旦他們看到了問題,他們通常會找到原因並開始試着修改。

“告訴我該怎麼做”

如今是網絡時代,是信息交流的時代。我可以點一下鼠標把自己的程序送到俄羅斯的某個朋友那裏,當然他也可以用同樣簡單的方法給我一些建議。但是如果我的程序出了什麼問題,我不可能在他旁邊。“演示”是很好的辦法,但是常常做不到。

如果您必須報告bug,而此時程序員又不在您身邊,那麼您就要想辦法讓bug重現在他們面前。當他們親眼看到錯誤時,就能夠進行處理了。

確切地告訴程序員您做了些什麼。如果是一個圖形界面程序,告訴他們您按了哪個按鈕,依照什麼順序按的。如果是一個命令行程序,精確的告訴他們您鍵入了什麼命令。您應該儘可能詳細地提供您所鍵入的命令和程序的反應。

把您能想到的所有的輸入方式都告訴程序員,如果程序要讀取一個文件,您可能需要發一個文件的拷貝給他們。如果程序需要通過網絡與另一臺電腦通訊,您或許不能把那臺電腦複製過去,但至少可以說一下電腦的類型和安裝了哪些軟件(如果可以的話)。

“哪兒出錯了?在我看來一切正常哦!”

如果您給了程序員一長串輸入和指令,他們執行以後沒有出現錯誤,那是因爲您沒有給他們足夠的信息,可能錯誤不是在每臺計算機上都出現,您的系統可能和他們的在某些地方不一樣。有時候程序的行爲可能和您預想的不一樣,這也許是誤會,但是您會認爲程序出錯了,程序員卻認爲這是對的。

同樣也要描述發生了什麼。精確的描述您看到了什麼。告訴他們爲什麼您覺得自己所看到的是錯誤的,最好再告訴他們,您認爲自己應該看到什麼。如果您只是說:“程序出錯了”,那您很可能漏掉了非常重要的信息。

如果您看到了錯誤消息,一定要仔細、準確的告訴程序員,它們很重要。在這種情況下,程序員只要修正錯誤,而不用去找錯誤。他們需要知道是什麼出問題了,系統所報的錯誤消息正好幫助了他們。如果您沒有更好的方法記住這些消息,就把它們寫下來。只報告“程序出了一個錯”是毫無意義的,除非您把錯誤消息一塊報上來。

特殊情況下,如果有錯誤消息號,一定要把這些號碼告訴程序員。不要以爲您看不出任何意義,它就沒有意義。錯誤消息號包含了能被程序員讀懂的各種信息,並且很有可能包含重要的線索。給錯誤消息編號是因爲用語言描述計算機錯誤常常令人費解。用這種方式告訴您錯誤的所在是一個最好的辦法。

在這種情形下,程序員的排錯工作會十分高效。他們不知道發生了什麼,也不可能到現場去觀察,所以他們一直在搜尋有價值的線索。錯誤消息、錯誤消息號以及一些莫名其妙的延遲,都是很重要的線索,就像辦案時的指紋一樣重要,保存好。

如果您使用UNIX系統,程序可能會產生一個內核輸出(core dump)。內核輸出是特別有用的線索來源,別扔了它們。另一方面,大多數程序員不喜歡收到含有大量內核輸出文件的EMAIL,所以在發郵件之前最好先問一下。還有一點要注意:內核輸出文件記錄了完整的程序狀態,也就是說任何祕密(可能當時程序正在處理一些私人信息或祕密數據)都可
能包含在內核輸出文件裏。

出了問題之後,我做了……”

當一個錯誤或bug發生的時候,您可能會做許多事情。但是大多數人會使事情變的更糟。我的一個朋友在學校裏誤刪了她所有的Word文件,在找人幫忙之前她重裝了Word,又運行了一遍碎片整理程序,這些操作對於恢復文件是毫無益處的,因爲這些操作搞亂了磁盤的文件區塊。恐怕在這個世界上沒有一種反刪除軟件能恢復她的文件了。如果她不做任何操作,或許還有一線希望。

這種人彷彿一隻被逼到牆角的鼬(黃鼠狼、紫貂一類的動物——譯者注):背靠牆壁,面對死亡的降臨奮起反撲,瘋狂***。他們認爲做點什麼總比什麼都不做強。然而這些在處理計算機軟件問題時並不適用。不要做鼬,做一隻羚羊。當一隻羚羊面對料想不到的情況或受到驚嚇時,它會一動不動,是爲了不吸引任何注意,與此同時也在思考解決問題的最好辦法(如果羚羊有一條技術支持熱線,此時佔線。)。然後,一旦它找到了最安全的行動方案,它便去做。

當程序出毛病的時候,立刻停止正在做的任何操作。不要按任何按鈕。仔細地看一下屏幕,注意那些不正常的地方,記住它或者寫下來。然後慎重地點擊 “確定” 或“取消”,選擇一個最安全的。學着養成一種條件反射——一旦電腦出了問題,先不要動。要想擺脫這個問題,關掉受影響的程序或者重新啓動計算機都不好,一個解決問題的好辦法是讓問題再次產生。程序員們喜歡可以被重現的問題,快樂的程序員可以更快而且更有效率的修復bug。

“我想粒子的躍遷與錯誤的極化有關”

並不只是非專業的用戶纔會寫出拙劣的bug報告,我見過一些非常差的bug報告出自程序員之手,有些還是非常優秀的程序員。

有一次我與另一個程序員一起工作,他一直在找代碼中的bug,他常常遇到一個bug,但是不會解決,於是就叫我幫忙。“出什麼毛病了?”我問。而他的回答卻總是一些關於bug的意見。如果他的觀點正確,那的確是一件好事。這意味着他已經完成了工作的一半,並且我們可以一起完成另一半工作。這是有效率並有用的。

但事實上他常常是錯的。這就會使我們花上半個小時在原本正確的代碼裏來回尋找錯誤,而實際上問題出在別的地方。我敢肯定他不會對醫生這麼做。“大夫,我得了Hydroyoyodyne(真是怪病——譯者),給我開個方子”,人們知道不該對一位醫生說這些。您描述一下症狀,哪個地方不舒服,哪裏疼、起皮疹、發燒……讓醫生診斷您得了什麼病,應該怎樣治療。否則醫生會把您當做疑心病或精神病患者打發了,這似乎沒什麼不對。

做程序員也是一樣。即便您自己的“診斷”有時真的有幫助,也要只說“症狀”。“診斷”是可說可不說的,但是“症狀”一定要說。同樣,在bug報告裏面附上一份針對bug而做出修改的源代碼是有用處的,但它並不能替代bug報告本身。

如果程序員向您詢問額外的信息,千萬別應付。曾經有一個人向我報告bug,我讓他試一個命令,我知道這個命令不好用,但我是要看看程序會返回一個什麼錯誤(這是很重要的線索)。但是這位老兄根本就沒試,他在回覆中說“那肯定不好用”,於是我又花了好些時間才說服他試了一下那個命令。

多動動腦筋對程序員是有幫助的。即使您的推斷是錯誤的,程序員也應該感謝您,您的嘗試使他們的工作變的更簡單。不過千萬別忘了報告“症狀”,否則只會使事情變得更糟。

“真是奇怪,剛纔還不好用,怎麼現在又好了?”

“間歇性錯誤”着實讓程序員發愁。相比之下,進行一系列簡單的操作便能導致錯誤發生的問題是簡單的。程序員可以在一個便於觀察的條件下重複那些操作,觀察每一個細節。太多的問題在這種情況下不能解決,例如:程序每星期出一次錯,或者偶然出一次錯,或者在程序員面前從不出錯(程序員一離開就出錯。——譯者)。當然還有就是程序的截止日期到了,那肯定要出錯。

大多數“間歇性錯誤”並不是真正的“間歇”。其中的大多數錯誤與某些地方是有聯繫的。有一些錯誤可能是內存泄漏產生的,有一些可能是別的程序在不恰當的時候修改某個重要文件造成的,還有一些可能發生在每一個小時的前半個小時中(我確實遇到過這種事情)。

同樣,如果您能使bug重現,而程序員不能,那很有可能是他們的計算機和您的計算機在某些地方是不同的,這種不同引起了問題。我曾寫過一個程序,它的窗口可以蜷縮成一個小球停在屏幕的左上角,它在別的計算機上只能在 800×600 解析度工作,但是在我的機器上卻可以在 1024×768 工作。

程序員想要了解任何與您發現的問題相關的事情。有可能的話您到另一臺機器上試試,多試幾次,兩次,三次,看看問題是不是經常發生。如果問題出現在您進行了一系列操作之後,不是您想讓它出現它就會出現,這就有可能是長時間的運行或處理大文件所導致的錯誤。程序崩潰的時候,您要儘可能的記住您都做了些什麼,並且如果您看到任何圖形, 也別忘了提一下。您提供的任何事情都是有幫助的。即使只是概括性的描述(例如:當後臺有EMACS運行時,程序常常出錯),這雖然不能提供導致問題的直接線索,但是可能幫助程序員重現問題。

最重要的是:程序員想要確定他們正在處理的是一個真正的“間歇性錯誤”呢,還是一個在另一類特定的計算機上纔出現的錯誤。他們想知道有關您計算機的許多細節,以便了解您的機器與他們的有什麼不同。有許多細節都依仗特定的程序,但是有一件東西您一定要提供——版本號。程序的版本、操作系統的版本以及與問題有關的程序的版本。

“我把磁盤裝進了我的Windows……”

表意清楚在一份bug報告裏是最基本的要求。如果程序員不知道您說的是什麼意思,那您就跟沒說一樣。我收到的bug報告來自世界各地,有許多是來自非英語國家,他們通常爲自己的英文不好而表示歉意。總的來說,這些用戶發來的bug報告通常是清晰而且有用的。幾乎所有不清晰的bug報告都是來自母語是英語的人,他們總是以爲只要自己隨便說說,程序員就能明白。

精確:

如果做相同的事情有兩種方法,請說明您用的是哪一種。例如:“我選擇了‘載入’”,可能意味着“我用鼠標點擊‘載入’”或“我按下了‘ALT+L’”,說清楚您用了哪種方法,有時候這也有關係。

詳細:

信息寧多毋少!如果您說了很多,程序員可以略去一部分,可是如果您說的太少,他們就不得不回過頭再去問您一些問題。有一次我收到了一份bug報告只有一句話,每一次我問他更多事情時,他每次的回覆都是一句話,於是我花了幾個星期的時間纔得到了有用的信息。

謹慎使用代詞:

諸如“它”,“窗體”這些詞,當它們指代不清晰的時候不要用。來看看這句話:“我運行了FooApp,它彈出一個警告窗口,我試着關掉它,它就崩潰了。”這種表述並不清晰,用戶究竟關掉了哪個窗口?是警告窗口還是整個FooApp程序?您可以這樣說,“我運行FooApp程序時彈出一個警告窗口,我試着關閉警告窗口,FooApp崩潰了。”這樣雖然羅嗦點,但是很清晰不容易產生誤解。

檢查:

重新讀一遍您寫的bug報告,您覺得它是否清晰?如果您列出了一系列能導致程序出錯的操作,那麼照着做一遍,看看您是不是漏寫了一步。

小結:

bug 報告的首要目的是讓程序員親眼看到錯誤。如果您不能親自做給他們看,給他們能使程序出錯的詳細的操作步驟。

如果首要目的不能達成,程序員不能看到程序出錯。這就需要bug報告的第二個目的來描述程序的什麼地方出毛病了。詳細的描述每一件事情:您看到了什麼,您想看到什麼,把錯誤消息記下來,尤其是“錯誤消息號”。

當您的計算機做了什麼您料想不到的事,不要動!在您平靜下來之前什麼都別做。不要做您認爲不安全的事。

儘量試着自己“診斷”程序出錯的原因(如果您認爲自己可以的話)。即使做出了“診斷”,您仍然應該報告“症狀”。

如果程序員需要,請準備好額外的信息。如果他們不需要,就不會問您要。他們不會故意爲難自己。您手頭上一定要有程序的版本號,它很可能是必需品。

表述清楚,確保您的意思不能被曲解。

總的來說,最重要的是要做到精確。程序員喜歡精確。

本文來源
Copyright(C) 2001 by Eric S. Raymond
中文版 Copyleft 2001 by D.H.Grand(nOBODY/Ginux)
英文版:http://www.tuxedo.org/~esr/faqs/smart-questions.html
感謝 Eric 的耐心指點和同意,本文才得以完成併發布
本指南英文版版權爲 Eric Steven Raymond 所有
中文版版權由 D.H.Grand[nOBODY/Ginux] 所有

最後,不管是誰,來這裏回答問題都是憑一腔熱忱,憑興趣和心情,如果版面充斥讓人沒有興趣回答的問題,我想,對大家都不是好消息。自力更生真的很重要,不管你水平如何遇到什麼樣的困難,能自己解決多少就解決多少,然後再來求助,說需要什麼什麼幫助,多做一些努力只有好處沒有壞處,問一個好問題並不比問一個壞問題困難多少。

我個人的原則,一行以內的問題不再回答了,比如‘有人懂JSP嗎?如題’之類的問題我就
只看了。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章