一千萬個為什麽

搜索

錯誤報告文件


在我的工作中,我必須測試 Markdown文檔。這包括尋找與以下相關的錯誤:

  • The procedure described in the document
  • Typos, grammar mistakes, etc.
  • The HTML version of the document

現在,我們記錄錯誤的方法是這樣的:

  1. If a bug is a found, I write a comment in the document. I don't like this because:
    • It is not clear where the bug is (is the bug in the word or paragraph that is before or after the comment?)
    • I can actually break the document if I don't write the comment correctly (e.g. by forgetting the closing -->)
  2. Once I am done testing, I use a tool that looks for the comments I wrote, and I paste them into a new issue in our bugtracker. I don't like this because:

    • Instead of creating a new issue per bug, I create one issue per document. This makes it hard for me to keep track of what bugs were fixed and what bugs were not fixed.
    • It may be hard for the devs to understand the bugs (imagine reading something like this:

      Line 8: SEVERITY 3 - PROCEDURE - Consider rewriting the above paragraph for clarity

      Is it immediately clear what the bug is? The dev now has to open the file that I edited and look for each and every one of the bugs. How tedious is that?

  3. In order to get statistics about the bugs found (type, severity, etc.), we use another tool that creates an Excel spreadsheet, and from there I have to create the graphs of statistics. I don't like this because:

    • We have to use two tools,
    • I have to create the graphs manually.

整個過程太復雜,妨礙了我的表現。

我知道我可以通過將兩個工具合二為一來修復(2)和(3),並自動創建圖形。

But how can I fix (1)?

註意:此問題也適用於其他類型的文檔(MS Word,最重要的是)。隨意建議以這些格式報告錯誤的方法。

最佳答案

正如@vincebowdren所說,從屏幕截圖開始。有許多簡單的截圖工具(我已經使用Windows 7剪切工具一段時間了 - 我可以使用鼠標在問題區域周圍畫一個粗糙的圓圈或突出顯示某些東西),其中許多都是免費軟件。我建議映射鍵盤快捷鍵以啟動屏幕截圖工具,以提高速度。

您沒有說您是否在錯誤跟蹤工具中報告每個文檔的單個問題,因為這是所需要的,或者因為它總是如此完成。如果你在每個問題上轉移到一個bug,你將使報告變得更容易(你的工具保證有一個數據庫後端,這意味著你可以構建一個簡單的前端來自動生成你的圖形 - 會有一個初始的建立報告界面的時間投入,但一旦完成,將節省大量的時間和準確性)

If reporting a single issue per document is policy and you can't change it, I'd recommend these options:

  • 對列出的項目進行編號,並將其與屏幕截圖相關聯。這將為您提供一種簡單的方法來判斷修復是否被覆蓋,並且開發人員可以輕松地了解問題所在。如果您的錯誤工具不允許您在線包含屏幕截圖,請將文件放在共享目錄中並列出指向它們的鏈接(例如):#3:Line 8:SEVERITY 3 - PROCEDURE - 考慮重寫段落在\\ files \ issuefiles \ documentname \ item3unclearpara.gif中為了清楚起見。
  • 如果無法合並工具,請使用Excel生成圖表以構建圖表的功能。您可能需要轉換自動生成的數據,但這可以通過宏來實現。

If you can change to reporting one issue per issue, I'd suggest considering these procedures:

  • 在為該文檔創建的每個問題中包含文檔標題/名稱。即使您的問題跟蹤工具允許您在問題之間創建父/子關系,我也會這樣做。這意味著您可以輕松搜索問題跟蹤系統,查找與特定文檔相關的所有問題。

  • 如果您的問題跟蹤系統允許父/子關系,我建議為該文檔創建一個主要問題,然後將每個問題作為子問題鏈接到它。這可用於簡化跟蹤和報告。

  • 如果發現每個問題,您可以直接挖掘問題跟蹤數據庫以生成指標和圖表。在您構建之前,使用Excel的圖形功能應該是可行的。

  • 通過問題跟蹤工具最佳支持的方法,為每個問題添加屏幕截圖。根據需要註釋或修改屏幕截圖。

Free screenshot tools I know of:

  • Windows 7及更高版本的剪切工具基本但功能齊全。它不支持文本註釋

  • Jing提供了一個很好的免費截圖工具,支持文本註釋。

  • Print Screen鍵並粘貼到Windows Paint或類似內容中可以進行基本圖像註釋和標記

  • 有關屏幕捕獲工具的更多信息,請訪問: http://www.techsupportalert.com/best-free-screen-capture-utility.htm

轉載註明原文: 錯誤報告文件

猜你喜歡