分享即關懷：如何撰寫有效的錯誤報告

任何人都能寫出像樣的錯誤報告，讀完這篇有用的部落格後，你就能寫出真正有效的錯誤報告了。

有時瀏覽手機時，我會意識到我使用的許多應用程式都是免費的。嗯……對我來說是免費的，但開發它們並非免費。每一款應用程式都是我花費數千小時開發、測試、編寫錯誤報告和調試後才免費發布的。

我們常常討論軟體開發生命週期（SDLC）的開發和測試環節，但bug環節呢？應用開發過程中難免會出現bug－這是自然且預料之中的。問題在於如何將這些bug回饋給開發團隊。任何人都能寫出像樣的bug報告，但真正有效的bug報告卻寥寥無幾。

溝通一如既往地至關重要。發現漏洞的人需要以簡潔有效的方式傳達細節和見解。

那麼，如何撰寫一份優秀的錯誤報告呢？讓我們一起來分析一下。

但首先，到底什麼是漏洞？

毫無疑問，你肯定遇到過這種情況。每個人都遇到過…除非他們從未使用過電腦或智慧型手機。這種情況雖然有可能，但如今越來越少見了。

一種定義是，bug 是網頁或行動應用程式中的某種故障、錯誤或缺陷，會導致意外或不正確的行為。

無論對使用者還是對開發者來說，漏洞都會令人困擾。漏洞可大可小。一個漏洞可能只會導致輕微的資料錯誤，而另一個漏洞則可能導致整個系統崩潰。

無論如何，一旦發現漏洞，就必須上報。這不僅是開發者的責任——用戶也有權上報漏洞，他們的回饋確實有助於改進軟體或應用程式。

那麼，讓我們來看看如何改進你的錯誤報告，從而提高其有效性。最終目標是讓相關的錯誤得到修復。

一份有效的錯誤報告應具備以下特點

以上是基本要點。我們將在文章後面詳細介紹報告撰寫流程，但現在請確保您：

• 正確計數蟲害 — 您的錯誤回報需要使用易於識別的編號序列。這有助於識別每個錯誤記錄。如果您使用報告工具，該工具每次都會自動為錯誤報告編號。
• 重現錯誤 — 務必包含重現 bug 所需的所有步驟。請提供詳細的步驟說明，不要遺漏任何步驟，無論它看起來多麼無關緊要。如果無法重現 bug，就無法修復它。
• 請提供具體細節。 — 錯誤報告無需使用華麗的辭藻。請盡可能用簡潔的語言進行有效溝通。無論錯誤多麼相似，都不要合併報告。每個錯誤都應該單獨提交一份報告。

如何撰寫一份好的錯誤報告

我們稍後會詳細介紹錯誤報告模板，但在那之前，讓我們先仔細看看一些重要的技巧，這些技巧將幫助您編寫更好的錯誤報告：

1. 立即報告錯誤 — 如果在測試過程中發現錯誤，請立即撰寫報告，不要拖延。如果延遲撰寫報告，可能會遺漏一些步驟，導致無法重現該錯誤。
2. 多次重現錯誤 確保修復 bug 的最佳方法是提供詳細的複現步驟指南。我們也遇到無數無法復現的 bug，最終發現是環境或使用者操作失誤導致的。
3. 測試類似模組 — 開發人員會使用不同的程式碼來區分不同的模組，即使是相似的模組。你的錯誤可能已經在其他地方出現過，所以值得調查一下。
4. 寫一份摘要 — 摘要有助於從開發人員的角度分析缺陷。如果摘要準備和撰寫不當，會導致開發和測試延誤。溝通至關重要，您的報告將成為缺陷庫中搜尋的參考資料。
5. 回顧你的工作 — 請確保您的語言、措詞和說明清晰明了，以免造成誤解。
6. 跟進 — 提交報告後，請跟進。讓開發人員感受到你即使在報告撰寫過程中也積極參與。如果你讓開發團隊感受到你的重視，你的 bug 就更有可能得到解決。

撰寫缺陷報告時，務必了解你的受眾。這樣，你才能以簡化目標受眾測試流程的方式撰寫缺陷報告。

如何撰寫錯誤報告

如同先前承諾的，我們來建立一個模板，供您在組織內報告錯誤時使用。從頂部開始：

• 記者： 您的姓名和聯絡資訊。通常電子郵件地址就夠了。
• 產品名稱： 發現漏洞時正在使用的產品是什麼？
• 版本： 出現錯誤的產品的版本號碼。
• 組件： 該產品的主要子模組。
• 平台： 出現漏洞時你所使用的硬體。
• 操作系統： 必須具體說明出現該漏洞的不同版本和作業系統。而且要逐一詳細說明。
• 優先級： 很簡單。選擇錯誤修復的優先順序即可。
• 嚴重程度： 透過此指標，您可以描述漏洞對系統的影響程度。嚴重程度分為從微不足道到輕微、再到重大和嚴重漏洞不等。
• 庫存狀態： 衡量 bug 的完成程度，從「新建」到「已修復」。
• 受讓人： 如果你知道誰將負責修復這個漏洞，那麼請務必將報告分配給他/她。如果不知道，那就分配給經理，請他/她接手處理。
• 網址： 出現漏洞的位置。
• 概要： 簡要描述該漏洞。
• 描述： 請提供更詳細、更全面的錯誤描述，包括所有相關方面。您必須提供重現錯誤的詳細步驟。此外，還需說明應用程式的預期行為以及實際結果。

您的錯誤報告質量

缺陷報告必須品質優良。報告準備得越完善，開發團隊就越容易修復你發現的任何缺陷。缺陷報告是測試人員、開發人員和管理人員之間重要的溝通工具。

你努力準備盡可能完善的錯誤報告，這將有助於節省組織資源，並改善測試人員和開發人員之間的溝通。

在2021年，這一點顯得尤為重要，因為團隊都在遠距辦公，公司正在向雲端遷移，敏捷開發也日益普及。 DevOps 這些方法越來越受歡迎。這些變化使得溝通變得更加困難，並進而影響網站和行動應用程式的評估。

報告缺陷能夠幫助測試人員改進軟體—這是一種積極主動的行為。不要坐等問題被修復。測試人員積極參與缺陷發現，不僅展現了團隊的參與意願，也提升了測試團隊在組織中的地位。

如果您正在尋找一種發現需要記錄的錯誤的絕佳方法，請觀看最近的網路研討會“打破障礙：為什麼在 2021 年進行雲端測試至關重要“。