JIRA的BUG編寫規(guī)范

1、、摘要二、名詞解釋三、目的四、范圍五、BugBug 編寫規(guī)范o1.1.主題o2 2.描述o3.3.環(huán)境o4.4.截圖o5.5.其他六、注意事項一、摘要本文檔主要描述了技術(shù)產(chǎn)品部測試人員提交 BugBug 時需要遵守的規(guī)范二、名詞解釋 JIRAJIRAJIRAJIRA 是 AtlassianAtlassian 公司出品的項目與事務(wù)跟蹤工具，被廣泛應(yīng)用于缺陷跟蹤、客戶服務(wù)、需求收集、流程審批、任務(wù)跟蹤、項目跟蹤和敏捷管理等工作領(lǐng)域。三、目的規(guī)范 BugBug 編寫，一方面，可以方便開發(fā)人員根據(jù) BugBug 描述快速進行定位問題原因，減少溝通成本，另一方面，可以幫助測試經(jīng)理、非技術(shù)人員、產(chǎn)品經(jīng)理、

2、開發(fā)經(jīng)理及其他測試人員等了解 BugBug, ,第三，可以體現(xiàn)測試團隊的專業(yè)性、嚴謹性。四、范圍該文檔適合技術(shù)產(chǎn)品部測試人員使用，適合于任何產(chǎn)品和項目。五、Bug編寫規(guī)范1.1.主題為了節(jié)約開發(fā)閱讀 BugBug 時間，同時考慮到開發(fā)人員容易通過 BugBug 標題來猜想 BugBug, ,所以，BugBug 標題顯得尤為重要。以下為 BugBug 標題編寫時需要遵守的規(guī)范。1 1）用簡短的語句描述問題，主題文字過多，增加開發(fā)閱讀 BugBug 時間。2 2）格式：在什么位置，在什么條件下，做什么操作，操作的結(jié)果。XX-包舌；采購中心、集采采購、集采銷售、銷售中心、賺戶設(shè)置、云庫房./貞面小添

3、加頁：添加XX；修改頁：修改XXr列表頁：XX列表；洋情頁：XX詳情。非添加、修改、列表、詳情，則為面包屑或彈挺名稱如果屬于多標簽頁面，格式為“XX-頁面crab名稱）：，比如集采錯售-招標tt劃列表（待手演：二P在什么條件下：如果問題為兼容性 BugBug，比如瀏覽器兼容或者分辨率兼容。格式為“在 IE11IE11 瀏覽器下，如果 BugBug 不屬于兼容性問題，不用加此描述。做什么操作：問題觸發(fā)的動作，比如：”執(zhí)行審批通過”。操作的結(jié)果：即問題的表象，比如：字段“報送時間”取值不對、報 404404 錯誤。格式舉例：采購中心-招標計劃詳情：在 IE11IE11 瀏覽器下，展開“查看參與人員

4、”，內(nèi)容錯亂。3 3）除了第二點描述的格式，對于 BugBug 描述，除了描述實際的結(jié)果外，有時候我們會直接描述期望結(jié)果，比如，集采銷售-招標計劃列表：列表字段“填報時間”應(yīng)該修改為“報送時間”。4 4）描述無歧義。BugBug 描述如果有歧義，開發(fā)容易因為改錯 BugBug, ,導(dǎo)致增加 BugBug 修復(fù)成本。在什么位置：問題所在的路徑，格式為XX-XX-頁面:5 5）涉及界面 UIUI 的文字，用雙引號標注，比如：集采銷售-招標計劃列表：列表字段“報送時間”取值錯誤。2 2.描述描述是對 BugBug 標題的詳細補充，對于復(fù)雜 Bug,Bug,標題不足以幫助開發(fā)定位問題，需要詳細步驟來支

5、撐BugBug, ,描述可以與標題完全一致。2 2）對于標題不能描述清楚的 BugBug, ,描述一般格式如下：1 1 . .重現(xiàn)步驟2 2 . .【實際結(jié)果】3 3 . .【期望結(jié)果】一在實際編寫過程，可以省略某一部分，比如標題清晰表達了問題現(xiàn)象，此時再”【期望結(jié)果就能清晰表達問題3 3）對于需要復(fù)雜數(shù)據(jù)準備的 BugBug, ,在描述里備注賬號格式為：賬號/密碼，比如，lotus009qq.coom3.lotus009qq.coom3.環(huán)境環(huán)境為產(chǎn)生 BugBug 時，用戶使用的瀏覽器、操作系統(tǒng)、分辨率、賬號等，主要用于輔助開發(fā)排查問題。1 1）URL:BugURL:Bug 產(chǎn)生的頁面 U

6、RL,URL,方面開發(fā)快速找到修改代碼的地方。2 2）瀏覽器、操作系統(tǒng)、分辨率：如果是兼容性問題，需要在此注明產(chǎn)生問題的環(huán)境。4 4 . .截圖一份好的截圖，可以方便開發(fā)人員快速確認錯誤的表現(xiàn)形式和錯誤的位置。1 1）截圖工具統(tǒng)一使用：FSCapture.exeFSCapture.exe。2 2）不要僅僅截圖，需要在圖上標注出有問題的地方，并文字進行輔助說明。1 1）對于標題就能描述清楚的3 3）如果問題為 500500、404404 等錯誤，需要附上日志截圖，方便開發(fā)定位代碼行。4 4）如果 BugBug 為與需求不符 BugBug, ,截圖需要同時包括需求與系統(tǒng)實現(xiàn)，減少開發(fā)查閱需求的時間

7、5 5）如果 BugBug 為讀取數(shù)據(jù)錯誤，截圖需要同時包括數(shù)據(jù)庫的存儲結(jié)果及系統(tǒng)數(shù)據(jù)的展示的對比圖5 5 . .其他1 1）正確選擇“BugBug 分類”BugBug 來源來源解釋代碼邏輯錯誤代碼邏輯錯誤導(dǎo)致對的 BugBug未理解需求/需求遺漏實現(xiàn)因未理解需求導(dǎo)致功能實現(xiàn)錯誤需求描述，但開發(fā)未實現(xiàn)與 UIUI 不符未按照 UIUI 規(guī)范來進行開發(fā)用戶體驗不修改不會影響業(yè)務(wù)，但會影響用戶體驗產(chǎn)品描述錯誤產(chǎn)品描述錯誤導(dǎo)致的 BugBug產(chǎn)品需求及更測試階段，需求變更及其導(dǎo)致的 BugBug產(chǎn)品描述遺漏需求不完整導(dǎo)致的 BugBugBugBug 來源來源解釋部分瀏覽器、分辨率下才重現(xiàn)的 BugB

8、ug兼容性問題其他不屬于以上分類的 BugBug2 2）正確選擇 BugBug 的優(yōu)先級BugBug 優(yōu)先級別級別定義危險造成系統(tǒng)崩潰、數(shù)據(jù)丟失、主要功能完全丟失、測試完全受阻嚴重系統(tǒng)主要功能部分丟失、數(shù)據(jù)不能保存、次要功能完全丟失重要系統(tǒng)次要未完整實現(xiàn)、功能模塊失效、常見系統(tǒng)功能失效輕微不影響功能的失效、用戶體驗明顯不友好、界面不規(guī)范建議建議性問題，不修復(fù)/、影響系統(tǒng)發(fā)布上線3 3）正確選擇 BugBug 所屬卞 K K 塊 BugBug 模塊主要是用于 BugBug 分析和輸出測試報告時，做模塊 BugBug 統(tǒng)計六、注意事項1.1.一個 BugBug 只能包括一個錯誤同一個 BugBug

9、 里包括多個問題，開發(fā)修改 BugBug 的時候，容易遺漏，導(dǎo)致 BugBug 被多次 ReopenReopen2.2.3.3.所有 BugBug 統(tǒng)一記錄在 JIRAJIRA 中，測試人員在測試過程中發(fā)現(xiàn)的或非測試人員本身發(fā)現(xiàn)的 BugBug, ,無特殊情況，不能用其他工具記錄，同時不允許以口頭方式直接告知開發(fā)人員，統(tǒng)一記錄在 JIRAJIRA 中以便統(tǒng)一管理，一方面，有利于項目資產(chǎn)的建立及項目過程問題的分析，另一方面，避免造成記錄丟失或遺忘。4.4.5.5.避免重復(fù)提交 BugBug, ,BugBug 的重復(fù)提交會增加測試人員的工作量，同時也可能增加開發(fā)人員的心理壓力，所以在多人測試的時候,一方面，避免多人同時測試同一個功能點，另一方面，提 BugBug 之前