BUG 文檔模板


模板擴展說明

模板展說明所有內容僅供閱讀,看完請刪除!

忠告,請把讀者看作一個初入茅廬的小白,不要以為它知道什么,它應該知道什么,其實它什么都不知道。

因為工作的性質為醫生服務,為患者負責,所以在平時的軟件開發中,有很多跟台人員在實際使用或者測試中遇到一些軟件異常的問題,這些異常問題需要我們的跟台人員去了解,
或者老總、項目專員、質量體系等不懂軟件的人員,所以這里的模板把解決方案以自描述的方式定義,讓他們看懂這個問題的原理、觸發原因、初步排查方法、詳細排查方法、解
決方案、報告輸出、使用者注意事項等信息才是最重要的。這極大的方便新員工的培訓或者跟台人員的培訓,當然也是為了患者、醫生負責,也是為了自己的工作負責,讓開發人
員在實際開發工作中對自己的產生自信,畢竟這個閱讀這個文檔的人員可能是老總、開發人員,測試人員,跟台人員、項目專員、質量體系等人員。誰也不想讓別人看到自己的疏
忽大意嘛。

BUG模板

BUG 基本信息

// 待測試人員完善
測試環境: 代碼測試,集成測試,冒煙測試,臨床驗證
發現時間: 年月日 如 20201008
版 本 號: 軟件的版本號
嚴重程度: 輕微,嚴重,致命
測試人員: 測試人員的姓名

附件說明

// 待測試人員完善

附件名 附件說明
xxxxxxxxxxxxxxxxxxx.sql 數據庫文件
2020_10_09_05_29_56.log BUG 日志文件
xxxxxxxxxxxxxxxxxxx.zip CT 設備注冊數據集

預期結果

// 待測試人員完善

實際結果

// 待測試人員完善

BUG 復現步驟

// 待測試人員完善

  1. 打開 xxxxx 軟件
  2. 步驟二的操作簡介
  3. 步驟三的操作簡介
  4. 步驟四的操作簡介
  5. 步驟五的操作簡介
  6. 步驟六的操作簡介
  7. 重復步驟3至步驟6的操作

BUG 詳細描述

// 待測試人員完善
// BUG 的詳細說明

建議

// 待測試人員完善
// 測試人員的個人分析

BUG 源詳細分析

// 待開發人員完善
// 猜想一 這個BUG可能是由於xxxx原因造成的
// 猜想二 這個BUG可能是由於xxxx原因造成的

分析驗證

// 待開發人員完善
驗證猜想一

步驟一

步驟二

步驟三

結果

驗證猜想二

步驟一

步驟二

步驟三

結果

總結報告

// 待開發人員完善
// 如果 BUG 是無法復現,並且找不到一個完美的解決方案,那么就用A模板,否則用B模板

// 模板A 只適用與出現了類似於 BUG 的問題,而又實在給不出來具有說服力的解決方案。懸案這個詞就非常適合 模板A 的形容詞
xxxx的可能性: xx%
推論:
a
原理支撐:
該 BUG 涉及到的模塊及相關的原理進行簡單的介紹。
已知條件:
然后可得到xxxxxx的已知條件
假設條件:
可能是由於xxxxxx假設條件的支持,
推論結果:
描述理論上的結果
測試結果:
描述模擬的結果
結 語:

// 模板B 適用代碼錯誤,邏輯錯誤及其他錯誤

// 詳細說明原因

// 詳細說明解決方案

// 警告說明 -- 說明這個解決方案的必要輸入,如外部數據輸入,必要的運行環境等


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM