BUG描述規範

標籤：

BUG描述規範一、 目的與適用範圍 1.1 目的 

報告軟體測試錯誤的目的是為了保證修複錯誤的人員可以明確報告的錯誤，從而有利於分析錯誤產生的原因，定位錯誤，然後修正之。因此，報告軟體測試錯誤的基本要求是準確、簡潔、完整、規範。 

1.2 適用範圍 

本規範適用於測試過程中對BUG描述的規範與約束。 

二、 BUG描述規範 

1. 描述：簡潔、準確，完整，揭示錯誤實質，記錄缺陷或錯誤出現的位置 描述要準確反映錯誤的本質內容，簡短明了。為了便於尋找指定的測試錯誤，描述中要包含錯誤發生時的使用者介面（UI）。例如記錄對話方塊的標題、菜單、按鈕等控制項的名稱。  

2. 明確指明錯誤類型：布局、翻譯、功能等 ； 

  根據錯誤的現象，總結判斷錯誤的類型。例如，布局錯誤、翻譯錯誤、功能錯誤、雙位元組錯誤，這是最常見的缺陷或錯誤類型，其他形式的缺陷或錯誤也從屬於其中某種形式。  

3. 短行之間使用自動數字序號，使用相同的字型、字型大小、行間距；   短行之間使用自動數字序號，使用相同的字型、字型大小、行間距，可以保證各條記錄格式一致，做到規範專業。  

4. UI要加引號，可以單引號，推薦使用雙引號；  

  UI加引號，可以容易區分UI與普通文本，便於分辨、定位缺陷或錯誤。  

5. 每一個步驟盡量只記錄一個操作；   保證簡潔、條理井然，容易重複操作步驟。  

6. 確認步驟完整，準確，簡短；  

保證快速準確的重複錯誤，“完整”即沒有缺漏，“準確”即步驟正確，“簡短”即沒有多餘的步驟。  

7. 根據缺陷或錯誤類型，選擇圖象捕捉的方式；  

  為了直觀的觀察缺陷或錯誤現象，通常需要附加缺陷或錯誤出現的介面，以位元影像的形式作為附件附著在記錄的“附件”部分。為了節省空間的，又能真實反映缺陷或錯誤本質，可以捕捉缺陷或錯誤產生時的全螢幕，使用中視窗和局部地區。    

8. 附加必要的特殊文檔、個人建議和註解；  

  如果開啟某個特殊的文檔而產生的缺陷或錯誤，則必須附加該文檔，從而可以迅速再現缺陷或錯誤。有時，為了使缺陷或錯誤修正者進一步明確缺陷或錯誤的表現，可以附加個人的修改建議或註解。    

9. 檢查拼字和語法錯誤；  

在提交每條缺陷或錯誤之前，檢查拼字和文法，確保內容正確，正確的描述錯誤。  

10. 盡量使用業界慣用的表達術語和表達方法；  

  使用業界慣用的表達術語和表達方法，保證表達準確，體現專業化。    

11. 通用UI要統一、準確；  

  錯誤報表的UI要與測試的軟體UI保持一致，便於尋找定位。    

12. 盡量使用短語和短句，避免複雜句型句式；  

  軟體錯誤管理資料庫的目的是便於定位錯誤，因此，要求客觀的描述操作步驟，不需要修飾性的詞彙和複雜的句型，增強可讀性。    

13. 每條錯誤報表只包括一個錯誤；  

  每條錯誤報表只包括一個錯誤，可以使錯誤修正者迅速定位一個錯誤，集中精力每次只修正一個錯誤。校正者每次只校正一個錯誤是否已經正確修正。

BUG描述規範