工單技術事後分析(一個欄位 + 指標)
使用者將所有內容放在一個欄位中,並將其他分析欄位指向該欄位,這樣就不需要重複說明。請重現該工作流程。
設定
在處理任何其他事項之前,請先讀取 ~/.config/skills/analyse-causes/config.md。該檔案會設定追蹤系統及其工具、專案與工單鍵值模式、欄位格式、撰寫語言與標題、撰寫欄位、被指向的欄位及其指標文字,以及 MR 連結欄位。如果缺少該檔案,請告知使用者將 config.example.md(與此檔案相鄰)複製到 ~/.config/skills/analyse-causes/config.md 並填寫內容,然後停止。
目標:使用傳入的工單做為引數,否則使用會話中正在進行中的修正(diff / 分支 / MR)。
應產出的內容
一份完整的分析報告,使用設定的語言,以 Markdown 格式撰寫,並包含兩個章節(使用設定好的標題):
- 根本原因 - 技術上的「為什麼」。不要重述初始情況(症狀 / 工單描述)。要追溯到真正的起源:設計選擇、
常數/檔案:行號、錯誤的假設。絕不能是可見的症狀。 - 修正 - 什麼改變了,以及為什麼它能消除根本原因。要基於事實:選擇的機制、觸及的檔案/常數、產生的行為。此處不含 MR 連結:它會被放入設定的 MR 連結欄位。
規則:簡潔、使用簡短要點、使用精確的術語(常數、函式、檔案:行號),並與實際程式碼比對驗證。不要使用長破折號(U+2014)——使用連字符、逗號或重新措辭。
流程
- 識別工單:引數 = 符合設定模式的鍵值;否則為正在進行中的修正(會話的 diff / 分支 / MR)。
- 如有需要,透過設定的工具讀取工單,但不要複製其描述。
- 在程式碼中追溯根本原因,並列出修正的變更內容(git diff / MR)。
- 撰寫完整的分析報告。
- 顯示報告,然後以設定的格式填寫欄位:
- 撰寫欄位 <- 完整的分析報告
- 每個被指向的欄位 <- 一份單段落的文件,內容為設定的指標文字 如果沒有指定目標工單(會話中有正在進行中的修正但沒有對應鍵值),則僅顯示報告並提供填入欄位的選項。