BUG描述規範

BUG描述規範

1、 目的與適用範圍 

1.1 目的 

報告軟件測試錯誤的目的是爲了保證修復錯誤的人員能夠明確報告的錯誤，從而有利於分析錯誤產生的緣由，定位錯誤，而後修正之。所以，報告軟件測試錯誤的基本要求是準確、簡潔、完整、規範。 

1.2 適用範圍 

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

2、 BUG描述規範 

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

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

  根據錯誤的現象，總結判斷錯誤的類型。例如，佈局錯誤、翻譯錯誤、功能錯誤、雙字節錯誤，這是最多見的缺陷或錯誤類型，其餘形式的缺陷或錯誤也從屬於其中某種形式。  

3. 短行之間使用自動數字序號，使用相同的字體、字號、行間距；   短行之間使用自動數字序號，使用相同的字體、字號、行間距，能夠保證各條記錄格式一致，作到規範專業。  

4. UI要加引號，能夠單引號，推薦使用雙引號；  

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

5. 每個步驟儘可能只記錄一個操做；   保證簡潔、條理井然，容易重複操做步驟。  

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

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

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

  爲了直觀的觀察缺陷或錯誤現象，一般須要附加缺陷或錯誤出現的界面，以位圖的形式做爲附件附着在記錄的「附件」部分。爲了節省空間，又能真實反映缺陷或錯誤本質，能夠捕捉缺陷或錯誤產生時的全屏幕，活動窗口和局部區域。    

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

  若是打開某個特殊的文檔而產生的缺陷或錯誤，則必須附加該文檔，從而能夠迅速再現缺陷或錯誤。有時，爲了使缺陷或錯誤修正者進一步明確缺陷或錯誤的表現，能夠附加我的的修改建議或註解。    

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

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

10. 儘可能使用業界慣用的表達術語和表達方法；  

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

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

  錯誤報告的UI要與測試的軟件UI保持一致，便於查找定位。    

12. 儘可能使用短語和短句，避免複雜句型句式；  

  軟件錯誤管理數據庫的目的是便於定位錯誤，所以，要求客觀的描述操做步驟，不須要修飾性的詞彙和複雜的句型，加強可讀性。    

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

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