JIRA的BUG編寫(xiě)規(guī)范

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

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

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

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

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

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

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

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

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