五層文件系統 - 專案文檔管理架構
我們需要專門的 SKILL 處理我們的文件運作,我們之前可能有其他腳本或者 SKILL 處理相關工作,但是現在這是一個完整的整合描述跟處理模式
我們原本設計的是三重文件系統,但是現在會經過擴充把分工再度做拆分,重新調整不同的工作職責
changelog 是純粹的提供給其他工程師了解版本推進的變化
todo.md 是當前版本已知的待處理的問題,但是還沒加入執行的排程中,可能會在下一個版本或者更之後的版本處理這些問題,如果已經解決的任務應該要從 todo.md 移除
worklog 是記錄這個版本的大方向,這個版本任務的前情提要,整個版本的執行企劃,不包括執行細節,因為執行細節我們會交付給 ticket ,我們要確保的是 worklog 想要達到的目標都有達成,比如我們剛剛規劃的 step by step ,我們為什麼會這樣設計,為什麼我們需要這些設計相關的解釋,理論上,每一個工程師,不需要其他的 context 解釋,他應該能從當前版本的 worklog 理解所有人的工作目標跟工作要求
ticket 是所有任務的細節,會記錄任務從何而來,目標是什麼,執行的途中也會更新 ticket 的處理狀況跟進度 ,直到 ticket 被更新為完成為止
最後是我們剛剛新增的錯誤模式文件系統,當我們在執行 ticket 之前跟之後,都需要查詢或者更新相關的問題,蒐集問題,並且提供之後改善我們工作模式的參考素材
所以我們需要 SKILL 說明每個文件的職責,設計相關的 command 做更新或者查詢,用 hook 確保文件進度的同步,這是我們現在的工作模式的核心運作系統
每份文件的同步期待與守護機制是否匹配,有一套判準可對照:worklog 與 changelog 是 append-only 記錄(永不回改、標時點)、todo 是要機制守著的活文件、hook 正是那個機制——分級的完整推導見 #256 多份文件必然漂移。