寫英文bug的經驗總結


本文鏈接: https://www.cnblogs.com/hchengmx/p/10800855.html

由於工作原因,開bug的時候需要由英文開,剛開的時候比較痛苦,因為有些詞匯老師用的不太准確,后來通過多看美國人開的bug,就慢慢掌握開bug的技巧了,慢慢的就比較輕車熟路了。這篇文章就來總結一下我平時開bug的技巧, 其實中文的也比較類似了。


1. 開bug的一些原則

  1. 除非百分之百確定,否則不要用should,不要有你認為是XXXX的句子,盡量用陳述句,因為這樣萬一是As Designed,會被開發人員罵XX。
  2. 少用定語從句! 外國人真的很少用定語從句,可以考慮簡化為前置形容詞或者拆分成兩個句子,具體可以看這篇文章。https://zhuanlan.zhihu.com/p/32301914
  3. if/after,盡量盡量不要用這兩個詞,因為閱讀順序是從左往右的,if和after又在后面,不利於閱讀, 非要用的話,這兩個詞前面的句子不要太長;
  4. Repro steps句子也不要太長,長句子分成好幾個短句子,盡量短描述清晰, 不重要的步驟不需要放圖;
  5. 遇到比較奇怪的bug,需要貼上更多的信息,比如url/哪個資源/瀏覽器,最好再錄個視頻(防背鍋);

2. 一些重點詞匯

經常開bug的話,也是可以找到一些技巧的,常見的情況就那幾種,當XXXX,出現了XXXX;不應該出現XXXX;什么功能壞掉了;什么東西會導致XXX結果。常用的句型都可能是類似的。我就總結了以下幾個常用的詞匯/句型,然后句子示例是搜集的美國人寫的句子。由於工作隱私問題: 就刪除了一些關鍵句子,是不影響句子閱讀的。

should:

  • The saved list should show the actual report selected.
  • Scroll bar shouldn't be showed up when xxxx;

動名詞:

  • Clicking on the refresh button in saved list blade refreshes the xxxx.
  • clicking on xxxx in xxxx makes it switch to "loading..."
  • split by using Properites fails for "xxxxx"
  • Cohorts are not being used when xxxxxx
  • Adding request filters seems to be broken

when:

  • selected events are deselected when xxxxx
  • xxxxx appear as modified when opening
  • Getting data... is shown when no data is found
  • Wrong chart when splitting by xxxxx

happen:(多用在repro steps)

  • This seems to be happening across all our reports.

There be:

  • There are no xxxxx when just requests are selected
  • there's no selection for "xxxxx"
  • There is no feedback when saving report

Broken:

  • Adding request filters seems to be broken
  • time range dropdown in notebook is broken
  • Sort by xxxx is broken in the grid control
  • SplitBy for some dimensions is broken

特定的XXX:

  • Open Users for a resource that only has custom events and requests.
  • Click on one of the Add these filters on any Request clusters.
  • open a report with custom time range
  • The settings popup is hidden behind the new ME chart in Edge

if/after:

  • Dropdown stuck after closing custom time range window
  • Charts are not refreshed after deleting xxx
  • Queries keep UX stuck if time range changed xxx

make:

  • clicking on xxxxx in filters makes it switch to "loading..."
  • Saved list items don't have tooltips which makes it impossible to read reasonable lenght names

3. 開bug的幾個步驟

  1. 確定穩定重現的步驟
  2. 確定bug的幾個關鍵因素 (發生什么頁面,嚴重優先級,先決條件)
  3. 要是有先決條件,確定用什么 副詞,when?if?或者什么重要的單詞 Fail?Broken?Loading?should?There be?make?show?動名詞作主語?
  4. 完成標題,保證動詞/特定詞匯的准確性,不要出現語法錯誤,分享兩個網址,如何主動積累詞匯學習如何積累詞匯,批改網避免語法錯誤;
  5. 描述repro steps, 可參考上面的句子
  6. 可以補充期望是什么樣子? 實際是什么樣子? 要是不改可能會造成什么影響?
  7. 要是自己能定位問題,可以進行抓包,貼log,貼console,是哪一次PR導致錯誤;

本文希望對您有所幫助,如何問題可聯系我的個人微信

個人號


免責聲明!

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



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