在 Jira 中提 Bug 記錄時(shí)的書寫規(guī)范_V1.0

為了讓開發(fā)及相關(guān)人員查看 Bug 記錄時(shí)有一個(gè)高效案腺、賞心悅目的感受狐援,現(xiàn)制訂以下書寫規(guī)范栏账,望遵守踐行梁钾。

1.項(xiàng)目

?   原則上是發(fā)現(xiàn)者提測(cè)至本人所在的組
?   如果遇到一個(gè)Bug 不是本組的開發(fā)范疇武学,可以告之相關(guān)組的測(cè)試人員

2.問題類型

?   針對(duì) Bug祭往,統(tǒng)一選擇『缺陷』,前面有一個(gè) 蟲子圖標(biāo)

3.概要 ::格式:【功能模塊】【客戶端】頁面字體顯示與設(shè)計(jì)不符

?   第一個(gè)【】填寫 此問題所在的功能模塊信息
?   第二個(gè)【】填寫 此問題所在的客戶端(iOS/Android/Web 前端/Web 后臺(tái))
?   問題描述要簡(jiǎn)潔概要火窒,見字明意(一般控制在__15__個(gè)漢字以內(nèi))

4.報(bào)告人

?   誰提交的就填寫誰
?   無特殊情況硼补,Bug 的報(bào)告人負(fù)責(zé) Bug 修復(fù)的驗(yàn)證事宜
?   報(bào)告人,盡量上傳一張本人的近期頭像沛鸵,方便別人一看頭像就知道是誰(這一點(diǎn)很適合新來的員工快速認(rèn)識(shí)人)
?   報(bào)告人的名字請(qǐng)?zhí)顚懼形娜ㄉ祝灰云匆艋蚝?jiǎn)稱代替

5.描述 :: 一般包含五項(xiàng)內(nèi)容:【前置條件】【重現(xiàn)步驟】【實(shí)際結(jié)果】【期望結(jié)果】【復(fù)現(xiàn)率】,以顏色曲掰、【】進(jìn)行標(biāo)識(shí)疾捍,換行對(duì)齊::

?   __【前置條件】__
        ?   如果 Bug 是在特定的環(huán)境、機(jī)器上發(fā)現(xiàn)的栏妖,請(qǐng)明確標(biāo)識(shí)
        ?   前置條件乱豆,應(yīng)該放置在描述的最頂端進(jìn)行書寫
        ?   書寫內(nèi)容與標(biāo)題相比,縮進(jìn)一個(gè) Tab 鍵間隔
?   __【重現(xiàn)步驟】__
        ?   以項(xiàng)目編號(hào)標(biāo)識(shí)吊趾,進(jìn)行分步驟書寫(不可所有步驟書寫在一起)
        ?   步驟應(yīng)該簡(jiǎn)潔宛裕,一個(gè)操作一個(gè)步驟,每一個(gè)步驟占一行并以項(xiàng)目編號(hào)開始论泛,上下保持對(duì)齊
        ?   不易表述的操作揩尸,要錄屏,以mp4格式上傳附件屁奏,操作步驟間的時(shí)間間隔不能太長(zhǎng)也不能太短(錄屏?xí)r間1分鐘至10分鐘之間較好)
        ?   書寫內(nèi)容與標(biāo)題相比岩榆,縮進(jìn)一個(gè) Tab 鍵間隔
?   __【實(shí)際結(jié)果】__
        ?   Bug出現(xiàn)時(shí)的具體現(xiàn)象,避免模糊詞匯,直接描述實(shí)際現(xiàn)象
        ?   這個(gè)描述應(yīng)該遵循『眼見為實(shí)』勇边,不可描述自己想象到的
        ?   書寫內(nèi)容與標(biāo)題相比犹撒,縮進(jìn)一個(gè) Tab 鍵間隔
?   __【期望結(jié)果】__
        ?   以需求、用戶體驗(yàn)為前提進(jìn)行期望粒褒,做到有理有據(jù)
        ?   有好的改善意見识颊,可以謙遜的提出來,最好不要語氣強(qiáng)硬
        ?   書寫內(nèi)容與標(biāo)題相比奕坟,縮進(jìn)一個(gè) Tab 鍵間隔
?   __【復(fù)現(xiàn)率】__
        ?   如果 Bug并不能百分百復(fù)現(xiàn)祥款,這時(shí)要給出復(fù)現(xiàn)的頻率
        ?   復(fù)現(xiàn)率的寫法采用分子/分母的形式,不可約分(例如 6/8 ,代表測(cè)試8次月杉,出現(xiàn)了6次)
        ?   書寫內(nèi)容與標(biāo)題相比镰踏,縮進(jìn)一個(gè) Tab 鍵間隔

     *注,當(dāng)一個(gè)問題需要他人(例如 PO/UI)進(jìn)行確認(rèn)沙合、協(xié)助時(shí)奠伪,要使用『提及用戶』的功能,@到專人
066B1692-9A07-482C-9A99-D6DF4F8CAD17.png

6.優(yōu)先級(jí)

?   要根據(jù)問題進(jìn)行實(shí)際選擇首懈,不可使用默認(rèn)值
?   此級(jí)別站在測(cè)試員角度所得出的優(yōu)先級(jí)绊率,不是開發(fā)人員眼中的優(yōu)先級(jí)

7.標(biāo)簽

?   如果有,就選填一下

8.附件 :: 多數(shù)情況下是圖片究履、視頻滤否、日志::

?   移動(dòng)端,選用手機(jī)截圖功能保存圖片最仑,非拍照(截圖可以保證工整標(biāo)準(zhǔn)平面化視覺的)
?   優(yōu)先選用 jpg/jpeg 格式藐俺,這種格式保存的質(zhì)量是顯著小的
?   如果是透明的,要使用 png 格式
?   對(duì)于問題點(diǎn)泥彤,畫框欲芹、箭頭、文字說明進(jìn)行顯著標(biāo)注
?   圖片內(nèi)容清晰可見
?   圖片質(zhì)量不超過1MB吟吝,開發(fā)人員打開圖片菱父,即可呈現(xiàn)(避免加載費(fèi)時(shí))
?   圖片的名稱要見名知意,不可隨意(這張圖片是反映什么的剑逃,要填寫一下圖片的名稱)
?   多個(gè)附圖時(shí)浙宜,圖片要根據(jù)步驟先后,有序顯示
?   如果是 UI設(shè)計(jì)稿對(duì)比實(shí)際圖蛹磺,要將其拼接成一張圖片進(jìn)行上傳

9.問題

?   選擇此 Bug 所屬于的故事

10.經(jīng)辦人

?   一般情況下粟瞬,填寫此 Bug 的開發(fā)者
?   如果是需求、UI方面的問題萤捆,可以指給相關(guān)人員(這些人有可能不橙蛊罚看 Jira乓梨,要做好線下通知)

11.Epic Link

?   填寫拆分故事時(shí)的 Feature

12.Sprint

?   填寫當(dāng)前的迭代
?   如果是集成測(cè)試的 Bug,屆時(shí)填寫到集成測(cè)試的項(xiàng)目迭代    
書寫參照.jpg
jira.jpg
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末清酥,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子蕴侣,更是在濱河造成了極大的恐慌焰轻,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,406評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件昆雀,死亡現(xiàn)場(chǎng)離奇詭異辱志,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)狞膘,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門揩懒,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人挽封,你說我怎么就攤上這事已球。” “怎么了辅愿?”我有些...
    開封第一講書人閱讀 163,711評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵智亮,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我点待,道長(zhǎng)阔蛉,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,380評(píng)論 1 293
  • 正文 為了忘掉前任癞埠,我火速辦了婚禮状原,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘苗踪。我一直安慰自己颠区,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,432評(píng)論 6 392
  • 文/花漫 我一把揭開白布通铲。 她就那樣靜靜地躺著瓦呼,像睡著了一般。 火紅的嫁衣襯著肌膚如雪测暗。 梳的紋絲不亂的頭發(fā)上央串,一...
    開封第一講書人閱讀 51,301評(píng)論 1 301
  • 那天,我揣著相機(jī)與錄音碗啄,去河邊找鬼质和。 笑死,一個(gè)胖子當(dāng)著我的面吹牛稚字,可吹牛的內(nèi)容都是我干的饲宿。 我是一名探鬼主播厦酬,決...
    沈念sama閱讀 40,145評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼瘫想!你這毒婦竟也來了仗阅?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,008評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤国夜,失蹤者是張志新(化名)和其女友劉穎减噪,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體车吹,經(jīng)...
    沈念sama閱讀 45,443評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡筹裕,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,649評(píng)論 3 334
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了窄驹。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片朝卒。...
    茶點(diǎn)故事閱讀 39,795評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖乐埠,靈堂內(nèi)的尸體忽然破棺而出抗斤,到底是詐尸還是另有隱情,我是刑警寧澤丈咐,帶...
    沈念sama閱讀 35,501評(píng)論 5 345
  • 正文 年R本政府宣布豪治,位于F島的核電站,受9級(jí)特大地震影響扯罐,放射性物質(zhì)發(fā)生泄漏负拟。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,119評(píng)論 3 328
  • 文/蒙蒙 一歹河、第九天 我趴在偏房一處隱蔽的房頂上張望掩浙。 院中可真熱鬧,春花似錦秸歧、人聲如沸厨姚。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽谬墙。三九已至,卻和暖如春经备,著一層夾襖步出監(jiān)牢的瞬間拭抬,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評(píng)論 1 269
  • 我被黑心中介騙來泰國打工侵蒙, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留造虎,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 47,899評(píng)論 2 370
  • 正文 我出身青樓纷闺,卻偏偏與公主長(zhǎng)得像算凿,于是被迫代替她去往敵國和親份蝴。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,724評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容