主頁 >  其他 > 如何有效的撰寫bug報告?

如何有效的撰寫bug報告?

2021-01-15 07:10:19 其他

為什么要求有效的缺陷報告?

缺陷報告是測驗程序中最重要的部分,對產品的質量有較大的影響,是測驗人員價值的終極體現,好的缺陷報告可以減少研發部門的二次缺陷率、提高研發修改缺陷的速度、提高測驗部門的信用度、增強測驗和研發部門的協作,Bug寫的越好,在實際中為了修改這個bug花費的時間相對來說就會越少,測驗人員的信譽度和產品的貢獻度也會很好的提升,

衡量優秀缺陷報告的質量指標

 

·對于管理層來說,是清晰明了的,特別是在主題摘要這一級,
-對于研發人員來說,是有用的,提供能夠讓研發人員高效的除錯問題的相關資訊,使其很快的將bug從“打開"狀態轉變成“關閉"狀態,提高測驗和開發的作業效率,
·對于后期的維護,能夠有效的從bug資訊查詢出問題的描述和解決辦法
說來容易,在實踐中需要測驗人員仔細用心,

如何撰寫缺陷報告

缺陷報告作為測驗和研發之間的溝通的橋梁,測驗人員在報告bug的時候,有效的bug描述,會更加容易幫助開發解決問題,寫有效的缺陷報告不要求有較好的文字功底,關鍵是覆寫了研發所關注的要點,作為一個優秀的缺陷報告,應該包括以下內容:

 

一、摘要
簡明扼要的對bug進行一個概述,目的是讓人看了就知道大概出了什么問題,Bug標題必須簡短而且要求描述和傳達出準確的資訊,這個摘要一般比較短,所以使用一些精煉的關鍵詞是很必要的,比如:用戶登錄時,密碼顯示為明文,
以下是一些較差的摘要:

 

1、摘要太模糊:在用戶登錄界面,在輸入框中能看到輸入的內容,
分析:這個摘要太模糊,沒有準確的描述出現了什么問題,反而將問題出現時的狀態寫了上去,在一些標準中,密碼輸入框應顯示為密文,并且也沒有說明是在用戶名輸入框中還是密碼輸入框中顯示輸入的內容,

 

修正:用戶登錄時,密碼框中顯示輸入內容,2、不足夠的資訊∶密碼框問題,
分析:這個bug摘要資訊很不充足,不知道出了什么問題
太長的摘要:在用戶登錄界面,在輸入框中,輸入正確的用戶名和密碼,在密碼框中,顯示密碼資訊,
分析:此摘要有太多冗余資訊,把步驟添加到了摘要中,如“在輸入框中,輸入正確的用戶名和密碼”等這些完全可以放置到bug描述步驟中去,
修正:用戶登錄時,密碼框中顯示輸入內容,
備注:有些測驗人員將其命名為“標題”,這里以我們的QC為準,名為“摘要”

 

二、bug屬性
在撰寫bug缺陷報告時應該盡可能全面的描述bug的屬性,以QC為例,bug屬性包含如下:


產品模塊:發現的bug所屬的模塊測驗版本:當前的測驗版本
嚴重級別
所屬專案
是否可重現


三、負責人:

負責解決此問題的研發人員四、檢測者:發現此問題的測驗人員

四、檢測者:

發現此問題的測驗人員


五、根據公司的實際情況,增加了“部門”和“迭代周期"兩項,“部門"是必填項,“迭代周期"可選,

 

六、Bug的詳細描述
Bug的詳細描述要達到讓研發人員清晰這是一個什么問題,看了能夠自己復現的程度,所以要詳細但要避免冗余,要包含以下幾點∶
1、測驗配置:主要是產品的相關配置,比如:使用用戶登錄某一個系統,前提條件是需要注冊或者管理員添加用戶,又或者是其他如交換機或路由器等的配置
2、測驗環境:測驗所搭建的網路拓撲環境,對于不需要搭建網路環境的測驗,可省略,如升級安裝包等,
3、測驗步驟:這是比較關鍵的,目的是幫助研發重現,在有多條步驟的情況下組號列出1、2、3等步驟
4、預期結果和實際結果:這兩個實際上都應該寫的描述中,不但能夠做對比,而且能夠有效的證明這確實是一個bug,例如這樣的bug描述:

 

上述bug的描述在很熟悉測驗產品的情況下或許可以看懂,但都會猶豫一下他想表達什么意思,正確的結果是什么,錯誤的結果是什么,
在這種情況下若加上“預期結果"和“實際結果”,會使意思表達的更加明確,第二個bug將步驟和結果混雜在一起,可以這樣修改一下:
1:使用瀏覽器訪問登陸界面,
2∶輸入正確的用戶名和密碼,3∶然后點擊“登錄"按鈕,
預期結果:密碼輸入框,顯示資訊為密文,
實際結果:密碼輸入框內容為明文,

 

其他注意事項

 

在報告缺陷的程序中,除了上述描述外還應注意如下:
1.一個bug報告只能描述—個bug,如果將幾個問題都寫在一個bug報告中,開發人員很難發現自己的問題并解決,或者導致某些優先級高的bug沒有及時得到解決

2.Bug的唯一性:在提交bug報告之前,要確認這個bug是否已經被其他人發現并報告(搜索功能)

3.重現:有些bug很容易就重現,有些就很難,如果你能重現一個bug,應該準確的解釋必須的條件,應該列出所有的步驟,包括精確的組合,檔案名以及你碰到或重現這個問題的操作順序,如果你能夠確認這個問題在任何檔案,任何的操作順序等條件下都會發生,那也做好能夠給出一個明確的示例來幫助開發重現,如果發現一個不能重新的bug,就盡可能多的提供有效的資訊給你的開發人員,截圖、日志,抓包等對捕獲這個bug有幫助的資訊可以包含在你的bug報告中

4.定位:對于一個測驗人員來說,應該做一些有效的事情來幫助定位問題,要多想會不會是外部的什么特殊原因引起的這個問題?會不會是因為網路的問題導致資料不通?或者是應用軟體配置錯誤導致資料不通?如果實在不能定位問題原因,是否可以想辦法縮小出錯的范圍?盡量避免是由于測驗人員的問題導致誤報了bug,測驗人員定位bug的能力,一定程度上是測驗人員附加值的體現,能夠節省專案組相關人員的時間,縮短了回歸bug的時間,
5.報告bug時要使用中性語言,不要帶有感情色彩,不要帶有幽默也不要帶有任何不滿情緒,盡量考慮一下研發的情緒,

 

轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/248914.html

標籤:其他

上一篇:網路中繼

下一篇:關于 PPT 模板

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 網閘典型架構簡述

    網閘架構一般分為兩種:三主機的三系統架構網閘和雙主機的2+1架構網閘。 三主機架構分別為內端機、外端機和仲裁機。三機無論從軟體和硬體上均各自獨立。首先從硬體上來看,三機都用各自獨立的主板、記憶體及存盤設備。從軟體上來看,三機有各自獨立的作業系統。這樣能達到完全的三機獨立。對于“2+1”系統,“2”分為 ......

    uj5u.com 2020-09-10 02:00:44 more
  • 如何從xshell上傳檔案到centos linux虛擬機里

    如何從xshell上傳檔案到centos linux虛擬機里及:虛擬機CentOs下執行 yum -y install lrzsz命令,出現錯誤:鏡像無法找到軟體包 前言 一、安裝lrzsz步驟 二、上傳檔案 三、遇到的問題及解決方案 總結 前言 提示:其實很簡單,往虛擬機上安裝一個上傳檔案的工具 ......

    uj5u.com 2020-09-10 02:00:47 more
  • 一、SQLMAP入門

    一、SQLMAP入門 1、判斷是否存在注入 sqlmap.py -u 網址/id=1 id=1不可缺少。當注入點后面的引數大于兩個時。需要加雙引號, sqlmap.py -u "網址/id=1&uid=1" 2、判斷文本中的請求是否存在注入 從文本中加載http請求,SQLMAP可以從一個文本檔案中 ......

    uj5u.com 2020-09-10 02:00:50 more
  • Metasploit 簡單使用教程

    metasploit 簡單使用教程 浩先生, 2020-08-28 16:18:25 分類專欄: kail 網路安全 linux 文章標簽: linux資訊安全 編輯 著作權 metasploit 使用教程 前言 一、Metasploit是什么? 二、準備作業 三、具體步驟 前言 Msfconsole ......

    uj5u.com 2020-09-10 02:00:53 more
  • 游戲逆向之驅動層與用戶層通訊

    驅動層代碼: #pragma once #include <ntifs.h> #define add_code CTL_CODE(FILE_DEVICE_UNKNOWN,0x800,METHOD_BUFFERED,FILE_ANY_ACCESS) /* 更多游戲逆向視頻www.yxfzedu.com ......

    uj5u.com 2020-09-10 02:00:56 more
  • 北斗電力時鐘(北斗授時服務器)讓網路資料更精準

    北斗電力時鐘(北斗授時服務器)讓網路資料更精準 北斗電力時鐘(北斗授時服務器)讓網路資料更精準 京準電子科技官微——ahjzsz 近幾年,資訊技術的得了快速發展,互聯網在逐漸普及,其在人們生活和生產中都得到了廣泛應用,并且取得了不錯的應用效果。計算機網路資訊在電力系統中的應用,一方面使電力系統的運行 ......

    uj5u.com 2020-09-10 02:01:03 more
  • 【CTF】CTFHub 技能樹 彩蛋 writeup

    ?碎碎念 CTFHub:https://www.ctfhub.com/ 筆者入門CTF時時剛開始刷的是bugku的舊平臺,后來才有了CTFHub。 感覺不論是網頁UI設計,還是題目質量,賽事跟蹤,工具軟體都做得很不錯。 而且因為獨到的金幣制度的確讓人有一種想去刷題賺金幣的感覺。 個人還是非常喜歡這個 ......

    uj5u.com 2020-09-10 02:04:05 more
  • 02windows基礎操作

    我學到了一下幾點 Windows系統目錄結構與滲透的作用 常見Windows的服務詳解 Windows埠詳解 常用的Windows注冊表詳解 hacker DOS命令詳解(net user / type /md /rd/ dir /cd /net use copy、批處理 等) 利用dos命令制作 ......

    uj5u.com 2020-09-10 02:04:18 more
  • 03.Linux基礎操作

    我學到了以下幾點 01Linux系統介紹02系統安裝,密碼啊破解03Linux常用命令04LAMP 01LINUX windows: win03 8 12 16 19 配置不繁瑣 Linux:redhat,centos(紅帽社區版),Ubuntu server,suse unix:金融機構,證券,銀 ......

    uj5u.com 2020-09-10 02:04:30 more
  • 05HTML

    01HTML介紹 02頭部標簽講解03基礎標簽講解04表單標簽講解 HTML前段語言 js1.了解代碼2.根據代碼 懂得挖掘漏洞 (POST注入/XSS漏洞上傳)3.黑帽seo 白帽seo 客戶網站被黑帽植入劫持代碼如何處理4.熟悉html表單 <html><head><title>TDK標題,描述 ......

    uj5u.com 2020-09-10 02:04:36 more
最新发布
  • 2023年最新微信小程式抓包教程

    01 開門見山 隔一個月發一篇文章,不過分。 首先回顧一下《微信系結手機號資料庫被脫庫事件》,我也是第一時間得知了這個訊息,然后跟蹤了整件事情的經過。下面是這起事件的相關截圖以及近日流出的一萬條資料樣本: 個人認為這件事也沒什么,還不如關注一下之前45億快遞資料查詢渠道疑似在近日復活的訊息。 訊息是 ......

    uj5u.com 2023-04-20 08:48:24 more
  • web3 產品介紹:metamask 錢包 使用最多的瀏覽器插件錢包

    Metamask錢包是一種基于區塊鏈技術的數字貨幣錢包,它允許用戶在安全、便捷的環境下管理自己的加密資產。Metamask錢包是以太坊生態系統中最流行的錢包之一,它具有易于使用、安全性高和功能強大等優點。 本文將詳細介紹Metamask錢包的功能和使用方法。 一、 Metamask錢包的功能 數字資 ......

    uj5u.com 2023-04-20 08:47:46 more
  • vulnhub_Earth

    前言 靶機地址->>>vulnhub_Earth 攻擊機ip:192.168.20.121 靶機ip:192.168.20.122 參考文章 https://www.cnblogs.com/Jing-X/archive/2022/04/03/16097695.html https://www.cnb ......

    uj5u.com 2023-04-20 07:46:20 more
  • 從4k到42k,軟體測驗工程師的漲薪史,給我看哭了

    清明節一過,盲猜大家已經無心上班,在數著日子準備過五一,但一想到銀行卡里的余額……瞬間心情就不美麗了。最近,2023年高校畢業生就業調查顯示,本科畢業月平均起薪為5825元。調查一出,便有很多同學表示自己又被平均了。看著這一資料,不免讓人想到前不久中國青年報的一項調查:近六成大學生認為畢業10年內會 ......

    uj5u.com 2023-04-20 07:44:00 more
  • 最新版本 Stable Diffusion 開源 AI 繪畫工具之中文自動提詞篇

    🎈 標簽生成器 由于輸入正向提示詞 prompt 和反向提示詞 negative prompt 都是使用英文,所以對學習母語的我們非常不友好 使用網址:https://tinygeeker.github.io/p/ai-prompt-generator 這個網址是為了讓大家在使用 AI 繪畫的時候 ......

    uj5u.com 2023-04-20 07:43:36 more
  • 漫談前端自動化測驗演進之路及測驗工具分析

    隨著前端技術的不斷發展和應用程式的日益復雜,前端自動化測驗也在不斷演進。隨著 Web 應用程式變得越來越復雜,自動化測驗的需求也越來越高。如今,自動化測驗已經成為 Web 應用程式開發程序中不可或缺的一部分,它們可以幫助開發人員更快地發現和修復錯誤,提高應用程式的性能和可靠性。 ......

    uj5u.com 2023-04-20 07:43:16 more
  • CANN開發實踐:4個DVPP記憶體問題的典型案例解讀

    摘要:由于DVPP媒體資料處理功能對存放輸入、輸出資料的記憶體有更高的要求(例如,記憶體首地址128位元組對齊),因此需呼叫專用的記憶體申請介面,那么本期就分享幾個關于DVPP記憶體問題的典型案例,并給出原因分析及解決方法。 本文分享自華為云社區《FAQ_DVPP記憶體問題案例》,作者:昇騰CANN。 DVPP ......

    uj5u.com 2023-04-20 07:43:03 more
  • msf學習

    msf學習 以kali自帶的msf為例 一、msf核心模塊與功能 msf模塊都放在/usr/share/metasploit-framework/modules目錄下 1、auxiliary 輔助模塊,輔助滲透(埠掃描、登錄密碼爆破、漏洞驗證等) 2、encoders 編碼器模塊,主要包含各種編碼 ......

    uj5u.com 2023-04-20 07:42:59 more
  • Halcon軟體安裝與界面簡介

    1. 下載Halcon17版本到到本地 2. 雙擊安裝包后 3. 步驟如下 1.2 Halcon軟體安裝 界面分為四大塊 1. Halcon的五個助手 1) 影像采集助手:與相機連接,設定相機引數,采集影像 2) 標定助手:九點標定或是其它的標定,生成標定檔案及內參外參,可以將像素單位轉換為長度單位 ......

    uj5u.com 2023-04-20 07:42:17 more
  • 在MacOS下使用Unity3D開發游戲

    第一次發博客,先發一下我的游戲開發環境吧。 去年2月份買了一臺MacBookPro2021 M1pro(以下簡稱mbp),這一年來一直在用mbp開發游戲。我大致分享一下我的開發工具以及使用體驗。 1、Unity 官網鏈接: https://unity.cn/releases 我一般使用的Apple ......

    uj5u.com 2023-04-20 07:40:19 more