Bug report template: Difference between revisions

From LemonWiki共筆
Jump to navigation Jump to search
mNo edit summary
Tags: Mobile edit Mobile web edit
(31 intermediate revisions by the same user not shown)
Line 1: Line 1:
網站或軟體功能問題回報範本
網站或軟體功能問題回報範本


== 客戶填寫的表單 ==
== 客戶填寫的表單 (Takeaway) ==
 
* 問題描述 (Bug description)
* 出現問題的操作步驟 (Steps to reproduce)
* 遇到的問題狀況 (Actual behavior)
* 預期看到的結果 (Expected behavior)
* 軟硬體環境資訊
* 填寫者
 
== 客戶填寫的表單 詳細說明 ==
=== 問題描述 (Bug description) ===
=== 問題描述 (Bug description) ===
問題摘要描述
說明
* 當時你想要做什麼?
* 問題摘要描述


=== 出現問題的操作步驟 (Steps to reproduce) ===
=== 出現問題的操作步驟 (Steps to reproduce) ===
說明:  
說明:  
* 可以重複出現相同問題的操作步驟。如果無法重複出現相同問題,問題原因可能不是出在網站或軟體功能,而是外部因素,例如伺服器、網站連線速度等。
* 可以重複出現相同問題的操作步驟。如果無法重複出現相同問題,問題原因可能不是出在網站或軟體功能,而是外部因素,例如伺服器、網站連線速度等。
* 不需要假設任何原因,盡可能詳細描述操作細節。如果是軟體功能,可以紀錄最近電腦環境是否要變化。
* 不需要假設任何原因,盡可能詳細描述操作細節。如果是軟體功能,可以紀錄最近電腦環境是否有變化。
* 遇到問題時不要馬上就回報給工程團隊,可以試看看不同操作步驟或環境,會不會遇到相同問題,可以增加工程師對問題的了解。 (謝謝 [http://csscoke.com/ Amos] 分享!)


=== 遇到的問題狀況 (Actual behavior) ===
=== 遇到的問題狀況 (Actual behavior) ===
說明:  
說明:  
* 遇到什麼狀況
* 遇到什麼狀況
* 如果有畫面或訊息文字的話,可以使用 [[Screen Capture | 螢幕畫面擷取]] 工具,擷取電腦畫面或錯誤訊息文字
* 如果有畫面或訊息文字的話,可以使用 [[Screen Capture | 螢幕畫面擷取]] 工具,擷取電腦或 APP 的畫面和錯誤訊息文字
* 嘗試過哪些方法解決這個問題、發現怎樣的過渡辦法 (Workaround) 解決這個問題
* 嘗試過哪些方法解決這個問題、發現怎樣的替代過渡辦法 (Workaround) 可以解決這個問題


=== 預期看到的結果 (Expected behavior) ===
=== 預期看到的結果 (Expected behavior) ===
Line 21: Line 33:
* 提供開發者知道,也許是功能面問題、或者是跟使用者的預期出現認知落差。
* 提供開發者知道,也許是功能面問題、或者是跟使用者的預期出現認知落差。


=== 背景資訊 ===
=== 軟硬體環境資訊 ===
軟硬體資訊。網站可透過 [[User agent]] 偵測使用者部分的電腦環境、瀏覽器版本資訊。
軟硬體環境資訊。除了請使用者擷取環境資訊畫面、網站可透過 [[User agent]] 偵測使用者部分的電腦環境、瀏覽器版本資訊。
# 個人電腦作業系統 (桌面 --> 「我的電腦」圖示 --> 按右鍵選「內容」)
# 個人電腦作業系統 (桌面 --> 「我的電腦」圖示 --> 按右鍵選「內容」)
# 個人電腦的硬體規格 (CPU, 硬碟)、硬體型號
# 個人電腦的硬體規格 (CPU, 硬碟)、硬體型號
# 使用的軟體名稱 及 軟體版本 (通常在軟體上方選單列的說明 --> 關於該軟體)、瀏覽器
# 使用的軟體名稱 及 軟體版本 (通常在軟體上方選單列的說明 --> 關於該軟體)
# 瀏覽器版本
# 瀏覽器: (1) 瀏覽器名稱 及 瀏覽器版本。除了常見的瀏覽器,部份 APP 也可瀏覽網頁,例如: Facebook。 (2) 瀏覽器擴充套件<ref>「當我要下載這張憑證的元件時,它的頁面被 Privacy Badger 給擋掉了。」[https://medium.com/@yinchuchen/egov-tax-service-in-taiwan-2e90d143a600 新版報稅介面的挫折經驗 – YingChu Chen – Medium]</ref> (3) 信任的網站等設定。
# 防毒軟體
# 防毒軟體
# 防火牆
# 防火牆
# 網路頻寬 ex: [http://speed.hinet.net/ HiNet連線速率測試 - HiNet測速網站]
# 網路頻寬 ex: [http://speed.hinet.net/ HiNet連線速率測試 - HiNet測速網站]
# 相關連結網址
# 相關連結網址
=== 填寫者 ===
方便聯繫


== 內部團隊填寫的表單 ==
== 內部團隊填寫的表單 ==
增加「嚴重程度」項目


=== 嚴重程度 (Severity level) ===
=== 嚴重程度 (Severity level) ===
* 四種: 不重要的(Trivial), 小(Minor), 大(Major), 及災難(Catastrophic)
* 4種: 不重要的(Trivial), 小(Minor), 大(Major), 及災難(Catastrophic)
* 五種: 可忽略(Insignificant)、小(Minor)、中等(moderate)、大(Major)及災難(Catastrophic)
* 4種: 小(Minor), 一般(Normal), 大(Major), 嚴重(Critical) via [https://www.drupal.org/core/issue-priority Priority levels of issues | Drupal.org]
* 5種: 不重要的(Trivial), 小(Minor), 大(Major), 嚴重(Critical)、及 Blocker via [https://bitbucket.org/ Bitbucket]
* 5種: 可忽略(Insignificant)、小(Minor)、中等(moderate)、大(Major)及災難(Catastrophic)
 
== 問題討論 ==
問: 無法提供「可以重複出現相同問題的操作步驟」,要不要回報?
* 答: 個人意見是可以回報,但是不要期待是由開發者修復。因為問題可能不是程式功能,而出現在伺服器架構或者是網路速度等其他因素,需要不同角色參與解決。
 


== 其他 ==
* unit test & integration test


== 參考資料 ==
== 參考資料 ==
<References />
Message template - ''I have a bug to report'': source: [https://www.rememberthemilk.com/ Remember The Milk] {{access | date = 2015-03-02}}
Message template - ''I have a bug to report'': source: [https://www.rememberthemilk.com/ Remember The Milk] {{access | date = 2015-03-02}}
<pre>
<pre>
Line 52: Line 76:
</pre>
</pre>


* [https://drive.google.com/previewtemplate?id=1dIjvto1F3VpOKXtzPEwrD6k0HlTiagbbGb56S_FFTaQ&mode=public&ddrp=1# Bug Report Template]
 
* 相關頁面: [[PC SOS]]
* [https://github.com/docker/kitematic/issues/new New Issue · docker/kitematic]
* [https://stackoverflow.com/help/mcve How to create a Minimal, Complete, and Verifiable example - Help Center - Stack Overflow]
* [https://gitlab.com/help/user/project/description_templates Description templates · GitLab] {{access | date = 2017-10-25}}
* [https://www.riohondo.edu/its/helpdesk/writing-a-good-helpdesk-ticket/ Writing a Good Helpdesk Ticket | Information Technology Services] {{access | date = 2019-05-21}}
* [https://phabricator.wikimedia.org/ Wikimedia Phabricator]  
* 相關頁面: [[PC SOS]]、[[RequestTracker]], Issue Tracker
* unit test & integration test
 
{{Template:Troubleshooting}}
 
 


[[Category:Templates]] [[Category:Programming]] [[Category:Software]]
[[Category:Templates]] [[Category:Programming]] [[Category:Software]]

Revision as of 12:24, 23 November 2021

網站或軟體功能問題回報範本

客戶填寫的表單 (Takeaway)

  • 問題描述 (Bug description)
  • 出現問題的操作步驟 (Steps to reproduce)
  • 遇到的問題狀況 (Actual behavior)
  • 預期看到的結果 (Expected behavior)
  • 軟硬體環境資訊
  • 填寫者

客戶填寫的表單 詳細說明

問題描述 (Bug description)

說明

  • 當時你想要做什麼?
  • 問題摘要描述

出現問題的操作步驟 (Steps to reproduce)

說明:

  • 可以重複出現相同問題的操作步驟。如果無法重複出現相同問題,問題原因可能不是出在網站或軟體功能,而是外部因素,例如伺服器、網站連線速度等。
  • 不需要假設任何原因,盡可能詳細描述操作細節。如果是軟體功能,可以紀錄最近電腦環境是否有變化。
  • 遇到問題時不要馬上就回報給工程團隊,可以試看看不同操作步驟或環境,會不會遇到相同問題,可以增加工程師對問題的了解。 (謝謝 Amos 分享!)

遇到的問題狀況 (Actual behavior)

說明:

  • 遇到什麼狀況
  • 如果有畫面或訊息文字的話,可以使用 螢幕畫面擷取 工具,擷取電腦或 APP 的畫面和錯誤訊息文字
  • 嘗試過哪些方法解決這個問題、發現怎樣的替代過渡辦法 (Workaround) 可以解決這個問題

預期看到的結果 (Expected behavior)

說明:

  • 描述你預期看到怎樣的結果。
  • 提供開發者知道,也許是功能面問題、或者是跟使用者的預期出現認知落差。

軟硬體環境資訊

軟硬體環境資訊。除了請使用者擷取環境資訊畫面、網站可透過 User agent 偵測使用者部分的電腦環境、瀏覽器版本資訊。

  1. 個人電腦作業系統 (桌面 --> 「我的電腦」圖示 --> 按右鍵選「內容」)
  2. 個人電腦的硬體規格 (CPU, 硬碟)、硬體型號
  3. 使用的軟體名稱 及 軟體版本 (通常在軟體上方選單列的說明 --> 關於該軟體)、
  4. 瀏覽器: (1) 瀏覽器名稱 及 瀏覽器版本。除了常見的瀏覽器,部份 APP 也可瀏覽網頁,例如: Facebook。 (2) 瀏覽器擴充套件[1] (3) 信任的網站等設定。
  5. 防毒軟體
  6. 防火牆
  7. 網路頻寬 ex: HiNet連線速率測試 - HiNet測速網站
  8. 相關連結網址

填寫者

方便聯繫

內部團隊填寫的表單

增加「嚴重程度」項目

嚴重程度 (Severity level)

  • 4種: 不重要的(Trivial), 小(Minor), 大(Major), 及災難(Catastrophic)
  • 4種: 小(Minor), 一般(Normal), 大(Major), 嚴重(Critical) via Priority levels of issues | Drupal.org
  • 5種: 不重要的(Trivial), 小(Minor), 大(Major), 嚴重(Critical)、及 Blocker via Bitbucket
  • 5種: 可忽略(Insignificant)、小(Minor)、中等(moderate)、大(Major)及災難(Catastrophic)

問題討論

問: 無法提供「可以重複出現相同問題的操作步驟」,要不要回報?

  • 答: 個人意見是可以回報,但是不要期待是由開發者修復。因為問題可能不是程式功能,而出現在伺服器架構或者是網路速度等其他因素,需要不同角色參與解決。


參考資料

  1. 「當我要下載這張憑證的元件時,它的頁面被 Privacy Badger 給擋掉了。」新版報稅介面的挫折經驗 – YingChu Chen – Medium

Message template - I have a bug to report: source: Remember The Milk [Last visited: 2015-03-02]

1. What steps will reproduce the problem?

2. What is the expected result? What do you see instead?

3. Anything else you think we should know?



Troubleshooting of ...

Template