如何編寫好的錯誤報告？

Question

我想編寫更好的錯誤報告 - 在向我使用的軟件的開發人員報告錯誤時，我應該記住哪些事項？

Answer 1

我想說這取決於你的團隊/組織。然而，只是要記住，你可以去看看的：

1. Wikipedia Bug Report Template
2. Apache Bug Writing Template
3. Apple Bug Report Sample
4. 你可以找到任何其他操作系統項目相同。

添加從here提取更多的信息：

要具體。如果你可以用兩種不同的方式做同樣的事情，說明你使用了哪一種。 「我選擇加載」可能意味着「我點擊加載」或「我按Alt-L」。說你做了什麼。有時候很重要。 詳細地。提供更多信息而不是更少。如果你說得太多，程序員可以忽略一些。如果你說得太少，他們不得不回來問一些問題。我收到的一個錯誤報告是一句話;每次我詢問更多信息時，記者都會用另一句話回答。我花了幾個星期的時間纔得到有用的信息，因爲它一次只出現一個簡短的句子。 小心代詞。當不清楚它們的含義時，不要使用像「it」這樣的詞，或像「窗口」這樣的詞。考慮一下：「我創建了FooApp，它提出了一個警告窗口，我試圖關閉它，它崩潰了。」目前還不清楚用戶試圖關閉什麼。他們是否試圖關閉警告窗口或整個FooApp？它有所作爲。相反，你可以說「我啓動了FooApp，它彈出了一個警告窗口，我試圖關閉警告窗口，FooApp崩潰了。」這個更長，更重複，但也更容易誤解。 閱讀你寫的。將報告閱讀回自己，看看你是否清楚。如果您列出了一系列應該導致失敗的操作，請嘗試自行追蹤它們，以查看您是否錯過了某個步驟。

我會說，作爲必須提供描述，嚴重性，重現和狀態的步驟。然後你可以改變一些口味，通過添加標籤，受影響的版本，受讓人等。

希望這有助於！