編程世界經典秘籍:程序員的提問之道
簡介
在黑客的世界裏,當你拋出一個技術問題時,最終是否能得到有用的回答,往往取決於你所提問和追問的方式。本指南將教你如何正確的提問以獲得你滿意的答案。
不隻是黑客,現在開放源代碼(Open Source)軟件已經相當盛行,你常常也可以由其他有經驗的使用者身上得到好答案,這是件_好事_;使用者比起黑客來,往往對那些新手常遇到的問題更寬容一些。然而,將有經驗的使用者視為黑客,並采用本指南所提的方法與他們溝通,同樣也是能從他們身上得到滿意回答的最有效方式。
首先你應該明白,黑客們喜愛有挑戰性的問題,或者能激發我們思維的好問題。如果我們並非如此,那我們也不會成為你想詢問的對象。如果你給了我們一個值得反複咀嚼玩味的好問題,我們自會對你感激不盡。好問題是激勵,是厚禮。好問題可以提高我們的理解力,而且通常會暴露我們以前從沒意識到或者思考過的問題。對黑客而言,"好問題!"是誠摯的大力稱讚。
盡管如此,黑客們有著蔑視或傲慢麵對簡單問題的壞名聲,這有時讓我們看起來對新手、無知者似乎較有敵意,但其實不是那樣的。
我們不諱言我們對那些不願思考、或者在發問前不做他們該做的事的人的蔑視。那些人是時間殺手 -– 他們隻想索取,從不付出,消耗我們可用在更有趣的問題或更值得回答的人身上的時間。我們稱這樣的人為 失敗者(擼瑟) (由於曆史原因,我們有時把它拚作 lusers)。
在提問之前
在你準備要通過電子郵件、新聞群組或者聊天室提出技術問題前,請先做到以下事情:
嚐試在你準備提問的論壇的舊文章中搜索答案。
嚐試上網搜索以找到答案。
嚐試閱讀手冊以找到答案。
嚐試閱讀常見問題文件(FAQ)以找到答案。
嚐試自己檢查或試驗以找到答案
向你身邊的強者朋友打聽以找到答案。
如果你是程序開發者,請嚐試閱讀源代碼以找到答案。
當你提出問題的時候,請先表明你已經做了上述的努力;這將有助於樹立你並不是一個不勞而獲且浪費別人的時間的提問者。如果你能一並表達在做了上述努力的過程中所_學到_的東西會更好,因為我們更樂於回答那些表現出能從答案中學習的人的問題。
運用某些策略,比如先用 Google 搜索你所遇到的各種錯誤信息(既搜索 Google 論壇,也搜索網頁),這樣很可能直接就找到了能解決問題的文件或郵件列表線索。即使沒有結果,在郵件列表或新聞組尋求幫助時加上一句 我在 Google 中搜過下列句子但沒有找到什麼有用的東西 也是件好事,即使它隻是表明了搜索引擎不能提供哪些幫助。這麼做(加上搜索過的字串)也讓遇到相似問題的其他人能被搜索引擎引導到你的提問來。
別著急,不要指望幾秒鍾的 Google 搜索就能解決一個複雜的問題。在向專家求助之前,再閱讀一下常見問題文件(FAQ)、放輕鬆、坐舒服一些,再花點時間思考一下這個問題。相信我們,他們能從你的提問看出你做了多少閱讀與思考,如果你是有備而來,將更有可能得到解答。不要將所有問題一股腦拋出,隻因你的第一次搜索沒有找到答案(或者找到太多答案)。
準備好你的問題,再將問題仔細的思考過一遍,因為草率的發問隻能得到草率的回答,或者根本得不到任何答案。越是能表現出在尋求幫助前你為解決問題所付出的努力,你越有可能得到實質性的幫助。
小心別問錯了問題。如果你的問題基於錯誤的假設,某個普通黑客(J. Random Hacker)多半會一邊在心裏想著蠢問題…, 一邊用無意義的字麵解釋來答複你,希望著你會從問題的回答(而非你想得到的答案)中汲取教訓。
絕不要自以為_夠格_得到答案,你沒有;你並沒有。畢竟你沒有為這種服務支付任何報酬。你將會是自己去_掙到_一個答案,靠提出有內涵的、有趣的、有思維激勵作用的問題 --一個有潛力能貢獻社區經驗的問題,而不僅僅是被動的從他人處索取知識。
另一方麵,表明你願意在找答案的過程中做點什麼是一個非常好的開端。誰能給點提示?、我的這個例子裏缺了什麼?以及我應該檢查什麼地方比請把我需要的確切的過程貼出來更容易得到答複。因為你表現出隻要有人能指個正確方向,你就有完成它的能力和決心。
當你提問時
慎選提問的論壇
小心選擇你要提問的場合。如果你做了下述的事情,你很可能被忽略掉或者被看作失敗者:
- 在與主題不合的論壇上貼出你的問題
- 在探討進階技術問題的論壇張貼非常初級的問題;反之亦然
- 在太多的不同新聞群組上重複轉貼同樣的問題(cross-post)
- 向既非熟人也沒有義務解決你問題的人發送私人電郵
黑客會剔除掉那些搞錯場合的問題,以保護他們溝通的渠道不被無關的東西淹沒。你不會想讓這種事發生在自己身上的。
因此,第一步是找到對的論壇。再說一次,Google 和其它搜索引擎還是你的朋友,用它們來找到與你遭遇到困難的軟硬件問題最相關的網站。通常那兒都有常見問題(FAQ)、郵件列表及相關說明文件的鏈接。如果你的努力(包括_閱讀_ FAQ)都沒有結果,網站上也許還有報告 Bug(Bug-reporting)的流程或鏈接,如果是這樣,鏈過去看看。
向陌生的人或論壇發送郵件最可能是風險最大的事情。舉例來說,別假設一個提供豐富內容的網頁的作者會想充當你的免費顧問。不要對你的問題是否會受到歡迎做太樂觀的估計 -- 如果你不確定,那就向別處發送,或者壓根別發。
在選擇論壇、新聞群組或郵件列表時,別太相信名字,先看看 FAQ 或者許可書以弄清楚你的問題是否切題。發文前先翻翻已有的話題,這樣可以讓你感受一下那裏的文化。事實上,事先在新聞組或郵件列表的曆史記錄中搜索與你問題相關的關鍵詞是個極好的主意,也許這樣就找到答案了。即使沒有,也能幫助你歸納出更好的問題。
別像機關槍似的一次"掃射"所有的幫助渠道,這就像大喊大叫一樣會使人不快。要一個一個地來。
搞清楚你的主題!最典型的錯誤之一是在某種致力於跨平台可移植的語言、套件或工具的論壇中提關於 Unix 或 Windows 操作係統程序界麵的問題。如果你不明白為什麼這是大錯,最好在搞清楚這之間差異之前什麼也別問。
一般來說,在仔細挑選的公共論壇中提問,會比在私有論壇中提同樣的問題更容易得到有用的回答。有幾個理由可以支持這點,一是看潛在的回複者有多少,二是看觀眾有多少。黑客較願意回答那些能幫助到許多人的問題。
可以理解的是,老練的黑客和一些熱門軟件的作者正在接受過多的錯發信息。就像那根最後壓垮駱駝背的稻草一樣,你的加入也有可能使情況走向極端 -- 已經好幾次了,一些熱門軟件的作者從自己軟件的支持中抽身出來,因為伴隨而來湧入其私人郵箱的無用郵件變得無法忍受。
Stack Overflow
搜索,然後 在 Stack Exchange 問。
近年來,Stack Exchange community 社區已經成為回答技術及其他問題的主要渠道,尤其是那些開放源碼的項目。
因為 Google 索引是即時的,在看 Stack Exchange 之前先在 Google 搜索。有很高的機率某人已經問了一個類似的問題,而且 Stack Exchange 網站們往往會是搜索結果中最前麵幾個。如果你在 Google 上沒有找到任何答案,你再到特定相關主題的網站去找。用標簽(Tag)搜索能讓你更縮小你的搜索結果。
Stack Exchange 已經成長到超過一百個網站,以下是最常用的幾個站:
- Super User 是問一些通用的電腦問題,如果你的問題跟代碼或是寫程序無關,隻是一些網絡連線之類的,請到這裏。
- Stack Overflow 是問寫程序有關的問題。
- Server Fault 是問服務器和網管相關的問題。
網站和 IRC 論壇
本地的使用者群組(user group),或者你所用的 Linux 發行版本也許正在宣傳他們的網頁論壇或 IRC 頻道,並提供新手幫助(在一些非英語國家,新手論壇很可能還是郵件列表), 這些地方是開始提問的好首選,特別是當你覺得遇到的也許隻是相對簡單或者很普通的問題時。有廣告讚助的 IRC 頻道是公開歡迎提問的地方,通常可以即時得到回應。
事實上,如果程序出的問題隻發生在特定 Linux 發行版提供的版本(這很常見),最好先去該發行版的論壇或郵件列表中提問,再到程序本身的論壇或郵件列表提問。(否則)該項目的黑客可能僅僅回複 "用_我們的_版本"。
在任何論壇發文以前,先確認一下有沒有搜索功能。如果有,就試著搜索一下問題的幾個關鍵詞,也許這會有幫助。如果在此之前你已做過通用的網頁搜索(你也該這樣做),還是再搜索一下論壇,搜索引擎有可能沒來得及索引此論壇的全部內容。
通過論壇或 IRC 頻道來提供使用者支持服務有增長的趨勢,電子郵件則大多為項目開發者間的交流而保留。所以最好先在論壇或 IRC 中尋求與該項目相關的協助。
在使用 IRC 的時候,首先最好不要發布很長的問題描述,有些人稱之為頻道洪水。最好通過一句話的問題描述來開始聊天。
第二步,使用項目郵件列表
當某個項目提供開發者郵件列表時,要向列表而不是其中的個別成員提問,即使你確信他能最好地回答你的問題。查一查項目的文件和首頁,找到項目的郵件列表並使用它。有幾個很好的理由支持我們采用這種辦法:
- 任何好到需要向個別開發者提出的問題,也將對整個項目群組有益。反之,如果你認為自己的問題對整個項目群組來說太愚蠢,也不能成為騷擾個別開發者的理由。
- 向列表提問可以分散開發者的負擔,個別開發者(尤其是項目領導人)也許太忙以至於沒法回答你的問題。
- 大多數郵件列表都會被存檔,那些被存檔的內容將被搜索引擎索引。如果你向列表提問並得到解答,將來其它人可以通過網頁搜索找到你的問題和答案,也就不用再次發問了。
- 如果某些問題經常被問到,開發者可以利用此信息來改進說明文件或軟件本身,以使其更清楚。如果隻是私下提問,就沒有人能看到最常見問題的完整場景。
如果一個項目既有"使用者" 也有"開發者"(或"黑客")郵件列表或論壇,而你又不會動到那些源代碼,那麼就向"使用者"列表或論壇提問。不要假設自己會在開發者列表中受到歡迎,那些人多半會將你的提問視為幹擾他們開發的噪音。
然而,如果你_確信_你的問題很特別,而且在"使用者" 列表或論壇中幾天都沒有回複,可以試試前往"開發者"列表或論壇發問。建議你在張貼前最好先暗地裏觀察幾天以了解那裏的行事方式(事實上這是參與任何私有或半私有列表的好主意)
如果你找不到一個項目的郵件列表,而隻能查到項目維護者的電子郵件地址,盡管向他發信。即使是在這種情況下,也別假設(項目)郵件列表不存在。在你的電子郵件中,請陳述你已經試過但沒有找到合適的郵件列表,也提及你不反對將自己的郵件轉發給他人(許多人認為,即使沒什麼秘密,私人電子郵件也不應該被公開。通過允許將你的電子郵件轉發他人,你給了相應人員處置你郵件的選擇)。
使用有意義且描述明確的標題
在郵件列表、新聞群組或論壇中,大約 50 字以內的標題是抓住資深專家注意力的好機會。別用喋喋不休的幫幫忙、跪求、急(更別說救命啊!!!!這樣讓人反感的話,用這種標題會被條件反射式地忽略)來浪費這個機會。不要妄想用你的痛苦程度來打動我們,而應該是在這點空間中使用極簡單扼要的描述方式來提出問題。
一個好標題範例是目標 -- 差異式的描述,許多技術支持組織就是這樣做的。在目標部分指出是哪一個或哪一組東西有問題,在差異部分則描述與期望的行為不一致的地方。
蠢問題:救命啊!我的筆記本電腦不能正常顯示了!
聰明問題:X.org 6.8.1 的鼠標光標會變形,某牌顯卡 MV1005 芯片組。
更聰明問題:X.org 6.8.1 的鼠標光標,在某牌顯卡 MV1005 芯片組環境下 - 會變形。
編寫目標 -- 差異 式描述的過程有助於你組織對問題的細致思考。是什麼被影響了? 僅僅是鼠標光標或者還有其它圖形?隻在 X.org 的 X 版中出現?或隻是出現在 6.8.1 版中? 是針對某牌顯卡芯片組?或者隻是其中的 MV1005 型號? 一個黑客隻需瞄一眼就能夠立即明白你的環境_和_你遇到的問題。
總而言之,請想像一下你正在一個隻顯示標題的存檔討論串(Thread)索引中查尋。讓你的標題更好地反映問題,可使下一個搜索類似問題的人能夠關注這個討論串,而不用再次提問相同的問題。
如果你想在回複中提出問題,記得要修改內容標題,以表明你是在問一個問題, 一個看起來像 Re: 測試 或者 Re: 新 bug 的標題很難引起足夠重視。另外,在不影響連貫性之下,適當引用並刪減前文的內容,能給新來的讀者留下線索。
對於討論串,不要直接點擊回複來開始一個全新的討論串,這將限製你的觀眾。因為有些郵件閱讀程序,比如 mutt ,允許使用者按討論串排序並通過折疊討論串來隱藏消息,這樣做的人永遠看不到你發的消息。
僅僅改變標題還不夠。mutt 和其它一些郵件閱讀程序還會檢查郵件標題以外的其它信息,以便為其指定討論串。所以寧可發一個全新的郵件。
在網頁論壇上,好的提問方式稍有不同,因為討論串與特定的信息緊密結合,並且通常在討論串外就看不到裏麵的內容,故通過回複提問,而非改變標題是可接受的。不是所有論壇都允許在回複中出現分離的標題,而且這樣做了基本上沒有人會去看。不過,通過回複提問,這本身就是曖昧的做法,因為它們隻會被正在查看該標題的人讀到。所以,除非你_隻想_在該討論串當前活躍的人群中提問,不然還是另起爐灶比較好。
使問題容易回複
以請將你的回複寄到……來結束你的問題多半會使你得不到回答。如果你覺得花幾秒鍾在郵件客戶端設置一下回複地址都麻煩,我們也覺得花幾秒鍾思考你的問題更麻煩。如果你的郵件程序不支持這樣做,換個好點的;如果是操作係統不支持這種郵件程序,也換個好點的。
在論壇,要求通過電子郵件回複是非常無禮的,除非你相信回複的信息可能比較敏感(而且有人會為了某些未知的原因,隻讓你而不是整個論壇知道答案)。如果你隻是想在有人回複討論串時得到電子郵件提醒,可以要求網頁論壇發送給你。幾乎所有論壇都支持諸如追蹤此討論串、有回複時發送郵件提醒等功能。
用清晰、正確、精準並語法正確的語句
我們從經驗中發現,粗心的提問者通常也會粗心的寫程序與思考(我敢打包票)。回答粗心大意者的問題很不值得,我們寧願把時間耗在別處。
正確的拚字、標點符號和大小寫是很重要的。一般來說,如果你覺得這樣做很麻煩,不想在乎這些,那我們也覺得麻煩,不想在乎你的提問。花點額外的精力斟酌一下字句,用不著太僵硬與正式 -- 事實上,黑客文化很看重能準確地使用非正式、俚語和幽默的語句。但它_必須很_準確,而且有跡象表明你是在思考和關注問題。
正確地拚寫、使用標點和大小寫,不要將its混淆為it's,loose搞成lose或者將discrete弄成discreet。不要全部用大寫,這會被視為無禮的大聲嚷嚷(全部小寫也好不到哪去,因為不易閱讀。Alan Cox 也許可以這樣做,但你不行。)
更白話的說,如果你寫得像是個半文盲[譯注:小白],那多半得不到理睬。也不要使用即時通訊中的簡寫或火星文,如將的簡化為ㄉ會使你看起來像一個為了少打幾個鍵而省字的小白。更糟的是,如果像個小孩似地鬼畫符那絕對是在找死,可以肯定沒人會理你(或者最多是給你一大堆指責與挖苦)。
如果在使用非母語的論壇提問,你可以犯點拚寫和語法上的小錯,但決不能在思考上馬虎(沒錯,我們通常能弄清兩者的分別)。同時,除非你知道回複者使用的語言,否則請使用英語書寫。繁忙的黑客一般會直接刪除用他們看不懂語言寫的消息。在網絡上英語是通用語言,用英語書寫可以將你的問題在尚未被閱讀就被直接刪除的可能性降到最低。
如果英文是你的外語(Second language),提示潛在回複者你有潛在的語言困難是很好的: [譯注:以下附上原文以供使用]
English is not my native language; please excuse typing errors.
- 英文不是我的母語,請原諒我的錯字或語法
If you speak $LANGUAGE, please email/PM me; I may need assistance translating my question.
- 如果你說某語言,請寄信/私訊給我;我需要有人協助我翻譯我的問題
I am familiar with the technical terms, but some slang expressions and idioms are difficult for me.
- 我對技術名詞很熟悉,但對於俗語或是特別用法比較不甚了解。
I've posted my question in $LANGUAGE and English. I'll be glad to translate responses, if you only use one or the other.
- 我把我的問題用某語言和英文寫出來,如果你隻用一種語言回答,我會樂意將其翻譯成另一種。
使用易於讀取且標準的文件格式發送問題
如果你人為地將問題搞得難以閱讀,它多半會被忽略,人們更願讀易懂的問題,所以:
- 使用純文字而不是 HTML (關閉 HTML 並不難)。
- 使用 MIME 附件通常是可以的,前提是真正有內容(譬如附帶的源代碼或 patch),而不僅僅是郵件程序生成的模板(譬如隻是信件內容的拷貝)。
- 不要發送一段文字隻是一行句子但自動換行後會變成多行的郵件(這使得回複部分內容非常困難)。設想你的讀者是在 80 個字符寬的終端機上閱讀郵件,最好設置你的換行分割點小於 80 字。
- 但是,對一些特殊的文件_不要_設置固定寬度(譬如日誌檔案拷貝或會話記錄)。數據應該原樣包含,讓回複者有信心他們看到的是和你看到的一樣的東西。
- 在英語論壇中,不要使用Quoted-Printable MIME 編碼發送消息。這種編碼對於張貼非 ASCII 語言可能是必須的,但很多郵件程序並不支持這種編碼。當它們處理換行時,那些文本中四處散布的=20符號既難看也分散注意力,甚至有可能破壞內容的語意。
- 絕對,_永遠_不要指望黑客們閱讀使用封閉格式編寫的文檔,像微軟公司的 Word 或 Excel 文件等。大多數黑客對此的反應就像有人將還在冒熱氣的豬糞倒在你家門口時你的反應一樣。即便他們能夠處理,他們也很厭惡這麼做。
- 如果你從使用 Windows 的電腦發送電子郵件,關閉微軟愚蠢的智能引號功能 (從[選項] > [校訂] > [自動校正選項],勾選掉智能引號單選框),以免在你的郵件中到處散布垃圾字符。
在論壇,勿濫用表情符號和HTML功能(當它們提供時)。一兩個表情符號通常沒有問題,但花哨的彩色文本傾向於使人認為你是個無能之輩。過濫地使用表情符號、色彩和字體會使你看來像個傻笑的小姑娘。這通常不是個好主意,除非你隻是對性而不是對答案感興趣。
如果你使用圖形用戶界麵的郵件程序(如微軟公司的 Outlook 或者其它類似的),注意它們的默認設置不一定滿足這些要求。大多數這類程序有基於選單的查看源代碼命令,用它來檢查發送文件夾中的郵件,以確保發送的是純文本文件同時沒有一些奇怪的字符。
精確的描述問題並言之有物
- 仔細、清楚地描述你的問題或 Bug 的症狀。
- 描述問題發生的環境(機器配置、操作係統、應用程序、以及相關的信息),提供經銷商的發行版和版本號(如:Fedora Core 4、Slackware 9.1等)。
- 描述在提問前你是怎樣去研究和理解這個問題的。
- 描述在提問前為確定問題而采取的診斷步驟。
- 描述最近做過什麼可能相關的硬件或軟件變更。
- 盡可能的提供一個可以重現這個問題的可控環境的方法。
盡量去揣測一個黑客會怎樣反問你,在你提問之前預先將黑客們可能遇到的問題回答一遍。
以上幾點中,當你報告的是你認為可能在代碼中的問題時,給黑客一個可以重現你的問題的環境尤其重要。當你這麼做時,你得到有效的回答的機會和速度都會大大的提升。
Simon Tatham 寫過一篇名為《如何有效的報告 Bug》的出色文章。強力推薦你也讀一讀。
話不在多而在精
你需要提供精確有內容的信息。這並不是要求你簡單的把成堆的出錯代碼或者資料完全轉錄到你的提問中。如果你有龐大而複雜的測試樣例能重現程序掛掉的情境,盡量將它剪裁得越小越好。
這樣做的用處至少有三點。 第一,表現出你為簡化問題付出了努力,這可以使你得到回答的機會增加; 第二,簡化問題使你更有可能得到_有用_的答案; 第三,在精煉你的 bug 報告的過程中,你很可能就自己找到了解決方法或權宜之計。
別動輒聲稱找到 Bug
當你在使用軟件中遇到問題,除非你非常、_非常_的有根據,不要動輒聲稱找到了 Bug。提示:除非你能提供解決問題的源代碼補丁,或者提供回歸測試來表明前一版本中行為不正確,否則你都多半不夠完全確信。這同樣適用在網頁和文件,如果你(聲稱)發現了文件的Bug,你應該能提供相應位置的修正或替代文件。
請記得,還有許多其它使用者沒遇到你發現的問題,否則你在閱讀文件或搜索網頁時就應該發現了(你在抱怨前已經做了這些,是吧?)。這也意味著很有可能是你弄錯了而不是軟件本身有問題。
編寫軟件的人總是非常辛苦地使它盡可能完美。如果你聲稱找到了 Bug,也就是在質疑他們的能力,即使你是對的,也有可能會冒犯到其中某部分人。當你在標題中嚷嚷著有Bug時,這尤其嚴重。
提問時,即使你私下非常確信已經發現一個真正的 Bug,最好寫得像是_你_做錯了什麼。如果真的有 Bug,你會在回複中看到這點。這樣做的話,如果真有 Bug,維護者就會向你道歉,這總比你惹惱別人然後欠別人一個道歉要好一點。
低聲下氣不能代替你的功課
有些人明白他們不該粗魯或傲慢的提問並要求得到答複,但他們選擇另一個極端 -- 低聲下氣:我知道我隻是個可悲的新手,一個擼瑟,但...。這既使人困擾,也沒有用,尤其是伴隨著與實際問題含煳不清的描述時更令人反感。
別用原始靈長類動物的把戲來浪費你我的時間。取而代之的是,盡可能清楚地描述背景條件和你的問題情況。這比低聲下氣更好地定位了你的位置。
有時網頁論壇會設有專為新手提問的版麵,如果你真的認為遇到了初學者的問題,到那去就是了,但一樣別那麼低聲下氣。
描述問題症狀而非你的猜測
告訴黑客們你認為問題是怎樣造成的並沒什麼幫助。(如果你的推斷如此有效,還用向別人求助嗎?),因此要確信你原原本本告訴了他們問題的症狀,而不是你的解釋和理論;讓黑客們來推測和診斷。如果你認為陳述自己的猜測很重要,清楚地說明這隻是你的猜測,並描述為什麼它們不起作用。
蠢問題
我在編譯內核時接連遇到 SIG11 錯誤, 我懷疑某條飛線搭在主板的走線上了,這種情況應該怎樣檢查最好?
聰明問題
我的組裝電腦是 FIC-PA2007 主機板搭載 AMD K6/233 CPU(威盛 Apollo VP2 芯片組), 256MB Corsair PC133 SDRAM 內存,在編譯內核時,從開機 20 分鍾以後就頻頻產生 SIG11 錯誤, 但是在頭 20 分鍾內從沒發生過相同的問題。重新啟動也沒有用,但是關機一晚上就又能工作 20 分鍾。 所有內存都換過了,沒有效果。相關部分的標準編譯記錄如下…。
由於以上這點似乎讓許多人覺得難以配合,這裏有句話可以提醒你:所有的診斷專家都來自密蘇裏州。 美國國務院的官方座右銘則是:讓我看看(出自國會議員 Willard D. Vandiver 在 1899 年時的講話:我來自一個出產玉米,棉花,牛蒡和民主黨人的國家,滔滔雄辯既不能說服我,也不會讓我滿意。我來自密蘇裏州,你必須讓我看看。) 針對診斷者而言,這並不是一種懷疑,而隻是一種真實而有用的需求,以便讓他們看到的是與你看到的原始證據盡可能一致的東西,而不是你的猜測與歸納的結論。所以,大方的展示給我們看吧!
按發生時間先後列出問題症狀
問題發生前的一係列操作,往往就是對找出問題最有幫助的線索。因此,你的說明裏應該包含你的操作步驟,以及機器和軟件的反應,直到問題發生。在命令行處理的情況下,提供一段操作記錄(例如運行腳本工具所生成的),並引用相關的若幹行(如 20 行)記錄會非常有幫助。
如果掛掉的程序有診斷選項(如 -v 的詳述開關),試著選擇這些能在記錄中增加調試信息的選項。記住,多不等於好。試著選取適當的調試級別以便提供有用的信息而不是讓讀者淹沒在垃圾中。
如果你的說明很長(如超過四個段落),在開頭簡述問題,接下來再按時間順序詳述會有所幫助。這樣黑客們在讀你的記錄時就知道該注意哪些內容了。
描述目標而不是過程
如果你想弄清楚如何做某事(而不是報告一個 Bug),在開頭就描述你的目標,然後才陳述重現你所卡住的特定步驟。
經常尋求技術幫助的人在心中有個更高層次的目標,而他們在自以為能達到目標的特定道路上被卡住了,然後跑來問該怎麼走,但沒有意識到這條路本身就有問題。結果要費很大的勁才能搞定。
蠢問題
我怎樣才能從某繪圖程序的顏色選擇器中取得十六進製的的 RGB 值?
聰明問題
我正試著用替換一幅圖片的色碼(color table)成自己選定的色碼,我現在知道的唯一方法是編輯每個色碼區塊(table slot), 但卻無法從某繪圖程序的顏色選擇器取得十六進製的的 RGB 值。
第二種提問法比較聰明,你可能得到像是建議采用另一個更合適的工具的回複。
別要求使用私人電郵回複
黑客們認為問題的解決過程應該公開、透明,此過程中如果更有經驗的人注意到不完整或者不當之處,最初的回複才能夠、也應該被糾正。同時,作為提供幫助者可以得到一些獎勵,獎勵就是他的能力和學識被其他同行看到。
當你要求私下回複時,這個過程和獎勵都被中止。別這樣做,讓_回複者_來決定是否私下回答 -- 如果他真這麼做了,通常是因為他認為問題編寫太差或者太膚淺,以至於對其它人沒有興趣。
這條規則存在一條有限的例外,如果你確信提問可能會引來大量雷同的回複時,那麼這個神奇的提問句會是向我發電郵,我將為論壇歸納這些回複。試著將郵件列表或新聞群組從洪水般的雷同回複中解救出來是非常有禮貌的 -- 但你必須信守諾言。
清楚明確的表達你的問題以及需求
漫無邊際的提問是近乎無休無止的時間黑洞。最有可能給你有用答案的人通常也正是最忙的人(他們忙是因為要親自完成大部分工作)。這樣的人對無節製的時間黑洞相當厭惡,所以他們也傾向於厭惡那些漫無邊際的提問。
如果你明確表述需要回答者做什麼(如提供指點、發送一段代碼、檢查你的補丁、或是其他等等),就最有可能得到有用的答案。因為這會定出一個時間和精力的上限,便於回答者能集中精力來幫你。這麼做很棒。
要理解專家們所處的世界,請把專業技能想像為充裕的資源,而回複的時間則是稀缺的資源。你要求他們奉獻的時間越少,你越有可能從真正專業而且很忙的專家那裏得到解答。
所以,界定一下你的問題,使專家花在辨識你的問題和回答所需要付出的時間減到最少,這技巧對你有用答案相當有幫助 -- 但這技巧通常和簡化問題有所區別。因此,問我想更好的理解 X,可否指點一下哪有好一點說明?通常比問你能解釋一下 X 嗎?更好。如果你的代碼不能運作,通常請別人看看哪裏有問題,比要求別人替你改正要明智得多。
詢問有關代碼的問題時
別要求他人幫你調試有問題的代碼,不提示一下應該從何入手。張貼幾百行的代碼,然後說一聲:它不能工作會讓你完全被忽略。隻貼幾十行代碼,然後說一句:在第七行以後,我期待它顯示 ,但實際出現的是 比較有可能讓你得到回應。
最有效描述程序問題的方法是提供最精簡的 Bug 展示測試用例(bug-demonstrating test case)。什麼是最精簡的測試用例?那是問題的縮影;一小個程序片段能剛好展示出程序的異常行為,而不包含其他令人分散注意力的內容。怎麼製作最精簡的測試用例?如果你知道哪一行或哪一段代碼會造成異常的行為,複製下來並加入足夠重現這個狀況的代碼(例如,足以讓這段代碼能被編譯/直譯/被應用程序處理)。如果你無法將問題縮減到一個特定區塊,就複製一份代碼並移除不影響產生問題行為的部分。總之,測試用例越小越好(查看話不在多而在精一節)。
一般而言,要得到一段相當精簡的測試用例並不太容易,但永遠先嚐試這樣做的是種好習慣。這種方式可以幫助你了解如何自行解決這個問題 —- 而且即使你的嚐試不成功,黑客們也會看到你在嚐試取得答案的過程中付出了努力,這可以讓他們更願意與你合作。
如果你隻是想讓別人幫忙審查(Review)一下代碼,在信的開頭就要說出來,並且一定要提到你認為哪一部分特別需要關注以及為什麼。
別把自己家庭作業的問題貼上來
黑客們很擅長分辨哪些問題是家庭作業式的問題;因為我們中的大多數都曾自己解決這類問題。同樣,這些問題得由_你_來搞定,你會從中學到東西。你可以要求給點提示,但別要求得到完整的解決方案。
如果你懷疑自己碰到了一個家庭作業式的問題,但仍然無法解決,試試在使用者群組,論壇或(最後一招)在項目的使用者郵件列表或論壇中提問。盡管黑客們_會_看出來,但一些有經驗的使用者也許仍會給你一些提示。
去掉無意義的提問句
避免用無意義的話結束提問,例如有人能幫我嗎?或者這有答案嗎?。
首先:如果你對問題的描述不是很好,這樣問更是畫蛇添足。
其次:由於這樣問是畫蛇添足,黑客們會很厭煩你 -- 而且通常會用邏輯上正確,但毫無意義的回答來表示他們的蔑視, 例如:沒錯,有人能幫你或者不,沒答案。
一般來說,避免用 是或否、對或錯、有或沒有類型的問句,除非你想得到是或否類型的回答。
即使你很急也不要在標題寫緊急
這是你的問題,不是我們的。宣稱緊急極有可能事與願違:大多數黑客會直接刪除無禮和自私地企圖即時引起關注的問題。更嚴重的是,緊急這個字(或是其他企圖引起關注的標題)通常會被垃圾信過濾器過濾掉 -- 你希望能看到你問題的人可能永遠也看不到。
有半個例外的情況是,如果你是在一些很高調,會使黑客們興奮的地方,也許值得這樣去做。在這種情況下,如果你有時間壓力,也很有禮貌地提到這點,人們也許會有興趣回答快一點。
當然,這風險很大,因為黑客們興奮的點多半與你的不同。譬如從 NASA 國際空間站(International Space Station)發這樣的標題沒有問題,但用自我感覺良好的慈善行為或政治原因發肯定不行。事實上,張貼諸如緊急:幫我救救這個毛絨絨的小海豹!肯定讓你被黑客忽略或惹惱他們,即使他們認為毛絨絨的小海豹很重要。
如果你覺得這點很不可思議,最好再把這份指南剩下的內容多讀幾遍,直到你弄懂了再發文。
禮多人不怪,而且有時還很有幫助
彬彬有禮,多用請和謝謝您的關注,或謝謝你的關照。讓大家都知道你對他們花時間免費提供幫助心存感激。
坦白說,這一點並沒有比清晰、正確、精準並合法語法和避免使用專用格式重要(也不能取而代之)。黑客們一般寧可讀有點唐突但技術上鮮明的 Bug 報告,而不是那種有禮但含煳的報告。(如果這點讓你不解,記住我們是按問題能教給我們什麼來評價問題的價值的)
然而,如果你有一串的問題待解決,客氣一點肯定會增加你得到有用回應的機會。
(我們注意到,自從本指南發布後,從資深黑客那裏得到的唯一嚴重缺陷反饋,就是對預先道謝這一條。一些黑客覺得先謝了意味著事後就不用再感謝任何人的暗示。我們的建議是要麼先說先謝了,_然後_事後再對回複者表示感謝,或者換種方式表達感激,譬如用謝謝你的關注或謝謝你的關照。)
問題解決後,加個簡短的補充說明
問題解決後,向所有幫助過你的人發個說明,讓他們知道問題是怎樣解決的,並再一次向他們表示感謝。如果問題在新聞組或者郵件列表中引起了廣泛關注,應該在那裏貼一個說明比較恰當。
最理想的方式是向最初提問的話題回複此消息,並在標題中包含已修正,已解決或其它同等含義的明顯標記。在人來人往的郵件列表裏,一個看見討論串問題 X和問題 X - 已解決的潛在回複者就明白不用再浪費時間了(除非他個人覺得問題 X的有趣),因此可以利用此時間去解決其它問題。
補充說明不必很長或是很深入;簡單的一句你好,原來是網線出了問題!謝謝大家 – Bill比什麼也不說要來的好。事實上,除非結論真的很有技術含量,否則簡短可愛的小結比長篇大論更好。說明問題是怎樣解決的,但大可不必將解決問題的過程複述一遍。
對於有深度的問題,張貼調試記錄的摘要是有幫助的。描述問題的最終狀態,說明是什麼解決了問題,在此_之後_才指明可以避免的盲點。避免盲點的部分應放在正確的解決方案和其它總結材料之後,而不要將此信息搞成偵探推理小說。列出那些幫助過你的名字,會讓你交到更多朋友。
除了有禮貌和有內涵以外,這種類型的補充也有助於他人在郵件列表/新聞群組/論壇中搜索到真正解決你問題的方案,讓他們也從中受益。
至少,這種補充有助於讓每位參與協助的人因問題的解決而從中得到滿足感。如果你自己不是技術專家或者黑客,那就相信我們,這種感覺對於那些你向他們求助的大師或者專家而言,是非常重要的。問題懸而未決會讓人灰心;黑客們渴望看到問題被解決。好人有好報,滿足他們的渴望,你會在下次提問時嚐到甜頭。
思考一下怎樣才能避免他人將來也遇到類似的問題,自問寫一份文件或加個常見問題(FAQ)會不會有幫助。如果是的話就將它們發給維護者。
在黑客中,這種良好的後繼行動實際上比傳統的禮節更為重要,也是你如何透過善待他人而贏得聲譽的方式,這是非常有價值的資產。
文章轉載自 開源中國社區 [https://www.oschina.net]
最後更新:2017-06-30 14:01:49