Skip to content

Agent skill for systematic debugging with minimal logging, iterative fixes, and cleanup.

License

Notifications You must be signed in to change notification settings

LaiTszKin/systematic-debug

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 

Repository files navigation

Systematic Debug Skill

Brief Introduction

An agent skill for Codex/Claude workflows that applies a structured debugging loop: hypothesis, minimal logging, user reproduction, evidence-based fix, and log cleanup.

一個提供給 Codex/Claude 類代理使用的「系統化除錯」技能,目標是在不臆測的前提下,用最小修改快速定位問題、迭代修復,最後清理所有臨時日誌。

這個技能解決什麼問題

當你遇到以下情境時,特別適合使用本技能:

  • 問題可以重現,但根因不明
  • 錯誤發生在多個模組交界,僅靠肉眼難以判斷
  • 需要和使用者反覆協作(重現 → 回報日誌 → 修復)
  • 希望避免一次改太多造成新風險

核心方法

本技能採用固定迭代循環:

  1. 判斷最可能原因:先讀程式碼與現有訊息,形成可驗證假設。
  2. 加入最小必要日誌:只在關鍵路徑加可判斷的上下文。
  3. 提供重現步驟:引導使用者重現並回報日誌。
  4. 依日誌修復:以證據修正,再請使用者驗證。
  5. 移除臨時日誌:問題解決後,清理所有額外日誌。

設計原則

  • 證據優先:不靠猜測、不憑直覺直接大改。
  • 最小變更:每輪只做必要修改,降低回歸風險。
  • 可回收性:所有臨時日誌都要可追蹤、可移除。
  • 可溝通性:每次迭代都清楚交付「做了什麼、為何而做」。

典型交付內容

每一輪除錯建議輸出:

  • 新增日誌的位置與目的
  • 提供給使用者的重現步驟
  • 根據日誌得到的修復內容
  • 清理臨時日誌的確認

範例:一次完整除錯回合

使用者問題

「登入後偶發 500,但我無法穩定重現。」

代理實作(精簡版)

  1. 判斷可疑點:auth callback 在 token 交換後進入錯誤分支。
  2. 新增最小日誌:記錄 request id、token provider 回應狀態、錯誤碼。
  3. 提供重現步驟:
    • 使用測試帳號登入 10 次
    • 回報發生 500 當次的 request id 與完整錯誤日誌
  4. 依日誌修復:發現第三方回傳 timeout 時,程式誤當作無效 token。
  5. 驗證後移除日誌:確認修復成功後清除所有臨時 log。

預期輸出

  • 本輪新增日誌位置與目的
  • 使用者重現步驟
  • 依日誌完成的修復內容
  • 臨時日誌已清理的確認

檔案結構

  • SKILL.md:技能定義與完整流程規範

授權

本專案採用 MIT License

About

Agent skill for systematic debugging with minimal logging, iterative fixes, and cleanup.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published