Bug report template: Difference between revisions

Jump to navigation Jump to search
m
Tags: Mobile edit Mobile web edit
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
網站或軟體功能問題回報範本
網站或軟體功能問題回報範本


== 客戶填寫的表單 ==
== 客戶填寫的表單 (Takeaway) ==
 
* 問題描述 (Bug description)
* 預期看到的結果 (Expected behavior)
* 出現問題的操作步驟 (Steps to reproduce)
* 遇到的問題狀況 (Actual behavior)
* 軟硬體環境資訊
* 填寫者: 方便聯繫
 
Markdown 語法範本
<pre>
## 問題描述
<!-- 清楚簡潔地描述這個 bug -->
 
## 重現步驟
1. 前往 '...'
2. 點選 '...'
3. 滾動到 '...'
4. 看到錯誤
 
## 預期行為
<!-- 描述你預期應該發生什麼 -->
 
## 實際行為
<!-- 描述實際上發生了什麼 -->
 
## 截圖 / 影片
<!-- 如有相關截圖,請貼在此處 -->
 
## 環境
- 作業系統 (OS):
- 瀏覽器 / 版本:
- 裝置:
 
## 其他補充
<!-- 任何有助於理解此問題的資訊 -->
</pre>
 
== 客戶填寫的表單 詳細說明 ==
=== 問題描述 (Bug description) ===
=== 問題描述 (Bug description) ===
說明
說明
* 當時你想要做什麼?
* 當時你想要做什麼?
* 問題摘要描述
* 問題摘要描述
=== 預期看到的結果 (Expected behavior) ===
說明:
* 描述你預期看到怎樣的結果。
* 提供開發者知道:你希望功能可以達到什麼目標、或畫面效果有怎樣的變化,可以讓開發者瞭解現有功能跟使用者的預期出現認知落差。


=== 出現問題的操作步驟 (Steps to reproduce) ===
=== 出現問題的操作步驟 (Steps to reproduce) ===
Line 18: Line 61:
* 如果有畫面或訊息文字的話,可以使用 [[Screen Capture | 螢幕畫面擷取]] 工具,擷取電腦或 APP 的畫面和錯誤訊息文字
* 如果有畫面或訊息文字的話,可以使用 [[Screen Capture | 螢幕畫面擷取]] 工具,擷取電腦或 APP 的畫面和錯誤訊息文字
* 嘗試過哪些方法解決這個問題、發現怎樣的替代過渡辦法 (Workaround) 可以解決這個問題
* 嘗試過哪些方法解決這個問題、發現怎樣的替代過渡辦法 (Workaround) 可以解決這個問題
=== 預期看到的結果 (Expected behavior) ===
說明:
* 描述你預期看到怎樣的結果。
* 提供開發者知道,也許是功能面問題、或者是跟使用者的預期出現認知落差。


=== 軟硬體環境資訊 ===
=== 軟硬體環境資訊 ===
軟硬體環境資訊。除了請使用者擷取環境資訊畫面、網站可透過 [[User agent]] 偵測使用者部分的電腦環境、瀏覽器版本資訊。
軟硬體環境資訊。除了請使用者擷取螢幕畫面、網站可透過 [[User agent]] 偵測使用者部分的電腦環境、瀏覽器版本資訊。
# 個人電腦作業系統 (桌面 --> 「我的電腦」圖示 --> 按右鍵選「內容」)
# 個人電腦作業系統 (桌面 --> 「我的電腦」圖示 --> 按右鍵選「內容」)
# 個人電腦的硬體規格 (CPU, 硬碟)、硬體型號
# 個人電腦的硬體規格 (CPU, 硬碟)、硬體型號
Line 39: Line 77:


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


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


== 其他 ==
 
* unit test & integration test
* [[Testing]]
* [[RequestTracker]], Issue Tracker
* [https://gitlab.com/help/user/project/description_templates Description templates · GitLab] {{access | date = 2017-10-25}}


== 參考資料 ==
== 參考資料 ==
<References />
<References />


* [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
=== 其他問題範本 ===
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 69: Line 114:
</pre>
</pre>


* [https://drive.google.com/previewtemplate?id=1dIjvto1F3VpOKXtzPEwrD6k0HlTiagbbGb56S_FFTaQ&mode=public&ddrp=1# Bug Report Template]
OpenAI
* [https://github.com/docker/kitematic/issues/new New Issue · docker/kitematic]
<pre>
* 相關頁面: [[PC SOS]]
Please describe the issue you're encountering.
Please provide as much detail as possible, including:
- A description of the issue
- Steps to reproduce it
- A screenshot of the error message
 
</pre>
 




Line 78: Line 130:




[[Category:Templates]] [[Category:Programming]] [[Category:Software]]
[[Category:Templates]]  
[[Category:Programming]]  
[[Category:Software]]
[[Category:Revised with LLMs]]

Navigation menu