提供準確、完整、簡潔、一致的缺陷報告是體現軟件測試的專業性、高質量的主要評價指標。遺憾的是，一些缺陷報告經常包含過少或過多信息，而且組織混亂，難以理解。由此導致缺陷被退回，從而延誤及時修正，最壞的情況是由于沒有清楚地說明缺陷的影響，開發人員忽略了這些缺陷，使這些缺陷隨軟件版本一起發布出去。

    因此，軟件測試工程師必須認識到書寫軟件缺陷報告是測試執行過程的一項重要任務，首先要理解缺陷報告讀者的期望，遵照缺陷報告的寫作準則，書寫內容完備的軟件缺陷報告。本文將闡述軟件測試缺陷報告的讀者，描述軟件缺陷報告的主要組成部分和各部分的書寫要求，指出某些常見錯誤和實用改進方法，最后總結了缺陷報告的寫作要點。

    1. 缺陷報告的讀者對象

    在書寫軟件缺陷報告之前，需要明白誰是缺陷報告的讀者對象，知道讀者最希望從缺陷報告中獲得什么信息。通常，缺陷報告的直接讀者是軟件開發人員和質量管理人員，除此之外，來自市場和技術支持等部門的人也可能需要查看缺陷情況。每個閱讀缺陷報告的人都需要理解缺陷針對的產品和使用的技術。另外，他們不是軟件測試人員，可能對于具體軟件測試的細節了解不多。

    概括起來，缺陷報告的讀者最希望獲得的信息包括：

    *易于搜索軟件測試報告的缺陷； 
    *報告的軟件缺陷進行了必要的隔離，報告的缺陷信息更具體、準確； 
    *軟件開發人員希望獲得缺陷的本質特征和復現步驟； 
    *市場和技術支持等部門希望獲得缺陷類型分布以及對市場和用戶的影響程度。

    軟件測試人員的任務之一就是需要針對讀者的上述要求，書寫良好的軟件缺陷報告。

    2. 缺陷報告的寫作準則

    書寫清晰、完整的缺陷報告是對保證缺陷正確處理的最佳手段。 它也減少了工程師以及其它質量保證人員的后續工作。

    為了書寫更優良的缺陷報告，需要遵守“5C”準則：

    *Correct（準確）：每個組成部分的描述準確，不會引起誤解； 
    *Clear（清晰）：每個組成部分的描述清晰，易于理解； 
    *Concise（簡潔）：只包含必不可少的信息，不包括任何多余的內容； 
    *Complete（完整）：包含復現該缺陷的完整步驟和其他本質信息； 
    *Consistent（一致）：按照一致的格式書寫全部缺陷報告。
 
    3. 缺陷報告的組織結構

    盡管不同的軟件測試項目對于缺陷報告的具體組成部分不盡相同，但是基本組織結構都是大同小異的。一個完整的軟件缺陷報告通常由下列幾部分組成：

    *缺陷的標題； 
    *缺陷的基本信息； 
         &測試的軟件和硬件環境； 
         &測試的軟件版本； 
         &缺陷的類型； 
         &缺陷的嚴重程度； 
         &缺陷的處理優先級。 
    *復現缺陷的操作步驟； 
    *缺陷的實際結果描述； 
    *期望的正確結果描述； 
    *注釋文字和截取的缺陷圖像。

    對于具體測試項目而言，缺陷的基本信息通常是比較固定的，也是很容易描述的。實際書寫軟件缺陷報告容易出現問題的地方就是標題、操作步驟、實際結果、期望結果和注釋部分。下面針對這些“事故多發地帶”具體論述如何提供完整的信息，由于英文是軟件開發的主要語言，以下的軟件缺陷報告的信息都使用英文書寫。

原文轉自：http://www.anti-gravitydesign.com