Quality

[翻譯] 基本的錯誤回報:撰寫重現步驟的秘訣


Bug Report Basics: Tips for Writing the Steps to Reproduce a Bug
[翻譯] 基本的錯誤回報:撰寫重現步驟的秘訣
作者:Cheylene Thongkham
May 18, 2015
原文網址
https://leantesting.com/resources/bug-report-writing-steps-reproduce-bug/

As a QA tester, a bug report is one of your most important forms of communication. There is a lot of information to pack into each one, including details about the test environment, description, expected outcome, and actual income. However, without providing the instructions on how recreate the issue, developers have little chance of getting to the root of the problem and fixing things. That’s why writing the steps to reproduce a bug are so crucial. For those who are new to the process, here are a few tips for effectively writing instructions on reproducing bugs.
作為一個品管測試員,錯誤回報是你最重要的溝通方式。我們必須把很多資訊放到一起,其中包含測試環境,描述,預期產出,及目前狀況。然而,若沒有描述到如何重現這個狀況,開發者很難找到問題的根源並修復。也因此如何撰寫重現流程是尤其重要,對於剛踏入測試員生涯的朋友,這裡有幾個祕訣可以提高撰寫重現臭蟲流程的效率。

Know Your Audience
了解是誰在讀你的報告

Before you begin writing your bug report, think about who will be reading it. While developers are almost always the primary target audience, business analysts and other non-technical stakeholders may also review bug reports on certain projects, and you will need to cater your language and terminology accordingly. As a general rule, avoid abbreviations and highly technical terms without explanation when writing instructions for non-technical stakeholders. Adopt the perspective of a reader with little to no background information on the project, and then write your steps accordingly.
在開始寫錯誤報告之前,先思考誰會來讀你的報告。開發者是最大部分的讀者,商務分析,及其他非技術人員也有可能看到這個報告,因此你必須修飾語言與修辭來配合他們。一般來說,給非技術人員看時要避免縮寫及沒有說明的技術名詞。也就是假設讀者對此專案一知半解,然後再來撰寫重現流程。

Something else worth considering is the native language of your target audience. If you are working with an offshore development team where English is not everyone’s native language, do not include any slang or colloquial terms. Stick to simple or compound sentences that are clear and unambiguous.
Be Concise, Yet Detailed
接著要考慮的就是讀者的母語。假如你與一個母語非英語的工作團隊合作,那麼就減少使用俚語或口語文字。限制在簡單及完整的句子,表達清楚不要模糊。

The key to writing effective instructions on how to reproduce a bug is to straddle the line between detail and brevity. Each sentence needs to bring the reader one step closer to recreating the issue. Anything else can be added in the description section. Resist the urge to combine multiple instructions into one sentence. Instead, break everything down into its own separate step. The shorter a step is, the easier it is to read.
有效率地撰寫如何重現臭蟲步驟的關鍵就是在細節與重點之間做區分。重現細節的每一行都讓讀者更推進一步,重現問題。而其他的說明就加在細節的欄位。要忍住把複數指示在同一行寫完的衝動。相反地,把他們切斷成為不同的步驟。步驟越短,就越容易讀。

Keep Terminology Consistent
保持一致的術語

One of the best ways to improve clarity in your bug reports is to keep the structure of your instructions and the terminology you use consistent throughout the project. For example, if you are testing a website and refer to the website’s ‘homepage’ in one step, don’t call it the ‘home screen’ in a subsequent step. This will only slow readers down as they work through your instructions. Establish a set of keywords, verbs, and phrases (or adopt them from functional specifications), and then stick to them throughout the lifetime project.
增強錯誤回報清晰度最好的方式就是保持指令的結構與使用一致的術語。舉例來說,假如你正在測試網站,提到網站的首頁,就不要在其他步驟改用第一個畫面。那會減慢讀者閱讀的速度。建立一個關鍵字,動詞,語法的文庫,持續在同一個專案使用他們。

A good bug report will never win any writing awards. Your main goal is to convey information as clearly and as quickly as possible. You can accomplish this by maintaining the same sentence structure for each instruction and always work in chronological order.
好的臭蟲回報不是去追求修辭與文藻。首要目標是傳達清楚且簡潔的訊息。你可以在每個指令依循同樣的語法結構來達到這個目標,同時別忘了要依照時間順序寫。

Some Additional Tips for Bug Reports
其他的額外技巧

Before turning your bug report it, see if you can recreate the issue using the steps you’ve just written. If not, either the issue is intermittent or your instructions are missing key details. Finally, be careful of your tone as you write instructions and fill out the bug report. Remember that as a QA or tester, you are on the same side as the developer. Both your objectives are to create high quality software, so focus on the project or product rather than the developer as an individual.
在交付錯誤回報之前,試試看能不能用寫下的步驟重現問題。假如沒辦法的話,顯然指令有遺漏。最後注意指令中的語氣,記得作為一個測試員或品管,你是站在開發者這邊。你們的目標都是要提高軟體品質,所以要對事不對人。

廣告

發表迴響

在下方填入你的資料或按右方圖示以社群網站登入:

WordPress.com Logo

您的留言將使用 WordPress.com 帳號。 登出 / 變更 )

Twitter picture

您的留言將使用 Twitter 帳號。 登出 / 變更 )

Facebook照片

您的留言將使用 Facebook 帳號。 登出 / 變更 )

Google+ photo

您的留言將使用 Google+ 帳號。 登出 / 變更 )

連結到 %s