為什么你要讀這份指南?
簡(jiǎn)單地說(shuō)，如果你報(bào)告Bug越有效， 工程師完全修復(fù)它的可能性越大。
這份Bug寫(xiě)作指南是針對(duì)新手在書(shū)寫(xiě)有效的Bug報(bào)告方面進(jìn)行指導(dǎo)的常規(guī)指南，并非每個(gè)建議都正好適用于你的軟件項(xiàng)目。
如何寫(xiě)一份有用的Bug報(bào)告?
有用的Bug報(bào)告是用于正確修復(fù)Bug的。因此一份有用的Bug報(bào)告通常地有兩個(gè)特征：
可復(fù)現(xiàn)：
如果工程師不能發(fā)現(xiàn)或終證明這一Bug存在，工程師或許會(huì)將它標(biāo)記為 "WORKSFORME( 所有要重新產(chǎn)生這個(gè)bug的企圖是無(wú)效的)"或 " INVALID(描述的問(wèn)題不是一個(gè)bug ) "，并且繼續(xù)進(jìn)行下一個(gè)Bug的修復(fù)工作。任何你能提供的詳盡描述將為工程師修復(fù)Bug提供幫助。
詳細(xì)精確：
如果工程師能越早隔離、定位問(wèn)題，越可能方便地修復(fù)。
讓我們舉一個(gè)例子：你正在測(cè)試一個(gè)Web閱覽器，在訪問(wèn)foo.com網(wǎng)站時(shí)崩潰了，因此你想寫(xiě)一個(gè)Bug報(bào)告:
糟糕的Bug報(bào)告：“我的瀏覽器崩潰了。我正在訪問(wèn)foo.com。我的計(jì)算機(jī)使用 Windows系統(tǒng)。這真是個(gè)大問(wèn)題，你們應(yīng)該馬上修復(fù)它。順便說(shuō)一下，你們的圖標(biāo)真惡心，如果你們保留那些丑陋的圖標(biāo)，沒(méi)有人將再使用你們的軟件。還有我的祖母的主頁(yè)看上去外觀也不正確，或者，它們?nèi)桓銇y了。祝好運(yùn)。”
有用的Bug報(bào)告：“每當(dāng)我訪問(wèn)foo.com時(shí)應(yīng)用程序崩潰了，我使用的是在Win NT 4.0 (Service Pack 5) 系統(tǒng)上的 10.28.99版本。 我也曾重新引導(dǎo)進(jìn)入 Linux，使用10.28.99 Linux版本，這個(gè)問(wèn)題也出現(xiàn)了。我發(fā)現(xiàn)每次崩潰都發(fā)生在繪制這個(gè)頁(yè)面位于上端的 Foo橫幅的時(shí)候。我分析了頁(yè)面，發(fā)現(xiàn)除非你刪除 " border =0"屬性，否則下列圖片鏈接將導(dǎo)致應(yīng)用程序崩潰 ：(附圖片)
如何在Bugzilla中輸入你有用的Bug報(bào)告?
在你輸入你發(fā)現(xiàn)的Bug前，應(yīng)使用 Bugzilla查詢頁(yè)檢查是否你發(fā)現(xiàn)的是已知并被報(bào)告的Bug。（如果你發(fā)現(xiàn)的Bug同第37條已經(jīng)知道的結(jié)果相同，你報(bào)告的話，可能騷擾工程師，從而影響工程師修復(fù)Bug的效率。）
下一步，確認(rèn)你發(fā)現(xiàn)的Bug是在新的版本中所發(fā)生的。（工程師更傾向于對(duì)那些他們正在編寫(xiě)的代碼中的嚴(yán)重問(wèn)題感興趣，而不是對(duì)以前那些廢棄代碼中數(shù)以百計(jì)的Bug進(jìn)行修復(fù)。）
如果你已經(jīng)在當(dāng)前版本中發(fā)現(xiàn)了一個(gè)新的Bug，請(qǐng)?jiān)贐ugzilla中報(bào)告：
從你的Bugzilla主頁(yè)中，選擇“Enter a new bug”。
選擇你發(fā)現(xiàn)Bug的產(chǎn)品。
輸入你的電子郵件地址、密碼，然后按“Login”按鈕。（如果你遺忘或還沒(méi)有得到密碼，讓密碼正文框空白，并且按 " E-mail me a password "按鈕，不久你將收到包含你的密碼的電子郵件。）
現(xiàn)在，填寫(xiě)那張出現(xiàn)的表格。以下說(shuō)明表格中的所有含義：
你在哪兒發(fā)現(xiàn)了Bug？
1，產(chǎn)品：在哪一個(gè)產(chǎn)品中你發(fā)現(xiàn)了Bug？
你在上一頁(yè)已選擇 ，enter前已經(jīng)選擇，
2，版本：在產(chǎn)品的哪一個(gè)版本中你找到了Bug？
If applicable.如果有的話。
3，產(chǎn)品單元：在產(chǎn)品的哪一個(gè)單元中存在Bug？
Bugzilla在你輸入一個(gè)Bug時(shí)，要求你必須選擇一個(gè)產(chǎn)品單元。（如果你無(wú)法確定所列產(chǎn)品單元的意思，單擊產(chǎn)品單元鏈接，那將聯(lián)接到對(duì)每個(gè)產(chǎn)品單元的詳細(xì)描述，這會(huì)幫助你作出好選擇。）
4， 平臺(tái)：在哪一個(gè)硬件平臺(tái)上你找到了這個(gè)Bug？
（例如Macintosh、SGI、Sun、PC。）如果你知道這個(gè)Bug會(huì)發(fā)生在所有硬件平臺(tái)上，請(qǐng)選擇“All”，否則請(qǐng)選擇相應(yīng)的你發(fā)現(xiàn)Bug的硬件平臺(tái)，如果列表中沒(méi)有出現(xiàn)你的硬件平臺(tái)，請(qǐng)選擇“Other”。
5，OS：在哪一個(gè)操作系統(tǒng)（OS）中你找到了這個(gè)Bug？
（例如Linux、Windows NT、Mac OS 8.5。）
如果你知道這個(gè)Bug會(huì)發(fā)生在所有OS中，請(qǐng)選擇“All”，否則請(qǐng)選擇相應(yīng)的你發(fā)現(xiàn)Bug的OS，如果列表中沒(méi)有出現(xiàn)你的OS，請(qǐng)選擇“Other”。
這個(gè)Bug有多重要？
1，嚴(yán)重性：這個(gè)Bug的破壞性有多大？
這項(xiàng)值默認(rèn)為“normal”。（要為一個(gè)特定的Bug界定適當(dāng)?shù)膰?yán)重性，單擊嚴(yán)重性鏈接，你將得到每個(gè)選擇的完全解釋，從Critical到Enhancement。）
2，誰(shuí)將跟蹤解決Bug？
3，分配給：哪一個(gè)工程師將負(fù)責(zé)修復(fù)這個(gè)Bug？
在你提交Bug報(bào)告后，Bugzilla將自動(dòng)把Bug分配給默認(rèn)工程師；填寫(xiě)正文框?qū)⒃试S你用手工方式把它分配給其他工程師。（要察看每個(gè)產(chǎn)品單元的默認(rèn)工程師列表，請(qǐng)單擊產(chǎn)品單元鏈接。）
4，Cc：還有哪些人將收到這個(gè)Bug修復(fù)更新的電子郵件?
列出其他需要通過(guò)電子郵件收到這個(gè)Bug修復(fù)更新的人的完整的電子郵件地址。只要你愿意，你可以輸入足夠多的電子郵件地址，電子郵件地址之間必須用逗號(hào)分隔，不可有空格。
5，關(guān)于這個(gè)Bug你還能告訴工程師什么？
6，URL:在什么 URL中你發(fā)現(xiàn)這個(gè)Bug？
如果你是在特殊的 URL中遇到Bug，請(qǐng)?jiān)谶@里提供它（們）。如果你已經(jīng)將Bug隔離在一段特殊的HTML程序段中，也請(qǐng)?jiān)谶@里為它提供URL。
7，概述：你如何在大約60個(gè)字符之內(nèi)將這個(gè)Bug進(jìn)行描述？
一個(gè)好的概述能很快和識(shí)別一份Bug報(bào)告，否則，開(kāi)發(fā)者將不能通過(guò)Bug概述進(jìn)行有意義的查詢，并且在瀏覽一份有10頁(yè)長(zhǎng)的Bug列表時(shí)，可能忽略你的Bug報(bào)告。
關(guān)于“在Tosh Tecra 780DVD w/ 3c589C上安裝PCMCIA失敗”的概述是有用的標(biāo)題，而“軟件失敗”或 “安裝問(wèn)題”將是糟糕的標(biāo)題的例子。
8，描述：還有什么你能告訴工程師關(guān)于這個(gè)Bug的？
如果可能，在這個(gè)域中請(qǐng)?zhí)峁﹩?wèn)題診斷的詳細(xì)細(xì)節(jié)。
如果適用，下列的Bug報(bào)告模板將幫助你保證不會(huì)漏掉所有相關(guān)信息：(翻譯是我自己加的，不準(zhǔn)確的話請(qǐng)見(jiàn)諒!)
總的描述：對(duì)概述的更為詳細(xì)的補(bǔ)充
Drag-selecting any page crashes Mac builds in NSGetFactory
Bug復(fù)現(xiàn)的步驟：是跟蹤Bug必須的小集，包含所有的特殊安裝步驟。
1) View any web page. (I used the default sample page， resource:/res/samples/test0.html) 觀看所有網(wǎng)頁(yè)。 (我使用了缺省樣頁(yè)， 資源:/res/samples/test0.html)
2) Drag-select the page. (Specifically， while holding down the mouse button， drag the mouse pointer downwards from any point in the browser's content region to the bottom of the browser's content region.) 扯拽選擇頁(yè)。 (具體地， 當(dāng)持續(xù)鼠標(biāo)鍵時(shí)， 扯拽鼠標(biāo)向下從任何點(diǎn)在瀏覽器的美滿的區(qū)域?qū)g覽器的美滿的區(qū)域的底部。)
目前的結(jié)果：應(yīng)用程序在經(jīng)過(guò)那些步驟后的結(jié)果
The application crashed. 應(yīng)用被碰撞。(程序崩潰)
期望的結(jié)果：當(dāng)Bug不再出現(xiàn)時(shí)，應(yīng)用程序應(yīng)有的結(jié)果
The window should scroll downwards. Scrolled content should be selected. (Or， at least， the application should not crash.) 窗口應(yīng)該移動(dòng)向下。 應(yīng)該選擇移動(dòng)的內(nèi)容。 (或， 至少， 應(yīng)用不應(yīng)該碰撞。)
時(shí)間及硬件平臺(tái)：第一次出現(xiàn)這個(gè)Bug的時(shí)間及硬件平臺(tái)。
11/2/99 build on Mac OS (Checked Viewer & Apprunner) 11/2/99修造在Mac OS (被檢查的觀察者& Apprunner)
其它環(huán)境及硬件平臺(tái)：Bug是否出現(xiàn)在其他硬件平臺(tái)或?yàn)g覽器上。
- Oclearcase/" target="_blank" >ccurs On
Seamonkey (11/2/99 build on Windows NT 4.0)
- Doesn't Occur On
Seamonkey (11/4/99 build on Red Hat Linux; feature not supported) Internet Explorer 5.0 (RTM build on Windows NT 4.0)
Netscape Communicator 4.5 (RTM build on Mac OS)
-在Seamonkey
(11/2/99修造在Seamonkey (基于windows NT 4.0)
-不發(fā)生在11/4/99Red Hat Linux; 特點(diǎn)沒(méi)支持的) Internet Explorer 5.0 (RTM修造在windows NT 4.0)
Netscape Communicator 4.5 (RTM基于Mac OS)
其它信息：任何其他調(diào)試信息
Win32: if you receive a Dr. Watson error， please note the type of the crash， and the module that the application crashed in. (e.g. access violation in apprunner.exe)
Mac OS: if you're running MacsBug， please provide the results of a how and an sc.
Unix: please provide a minimized stack trace， which can be generated by typing gdb apprunner core into a shell prompt.
Win32: 如果您接受一個(gè) Dr. Watson 錯(cuò)誤， 請(qǐng)注意崩潰的型， 和模塊， 應(yīng)用碰撞了in. (即訪問(wèn)違例在apprunner.exe)
Mac OS: 如果你是在運(yùn)行MacsBug， 請(qǐng)?zhí)峁┰趺春蛃c 的結(jié)果。
Unix: 請(qǐng)?zhí)峁p到小的棧檢索， 可能由鍵入的gdb apprunner 核心引起入殼提示。
你已經(jīng)完成了一篇不錯(cuò)的bug報(bào)告！
