軟體工程
建立儲存庫架構圖譜
分層的儲存庫地圖,連結進入點、模組、資料儲存、外部系統與擁有權,讓工程師能評估變更影響,而不假裝圖譜已完整。
流程
照這個順序做。
- 設定儲存庫版本、語言、圖譜目的、預期細節層級,以及圖譜必須協助回答的問題。
- 盤點進入點、建置與部署檔案、套件、服務、資料儲存、佇列、外部整合,以及產生或 vendored 區域。
- 使用可用的原始碼與儲存庫證據追蹤匯入、呼叫、事件、設定與資料流,記錄精確路徑與信心。
- 將節點與關係整理成有用的系統、容器、元件與程式碼層,不要把不同責任塞進同一個框。
- 加入負責人、測試、文件、執行期依賴與外部系統標籤,明確標出推論、過時或無法取得的關係。
- 用代表性旅程、建置與測試驗證圖譜,記錄漂移、缺少的邊,以及每項修正的下一位負責人。
- 發布有版本的圖譜或圖,附圖例、證據連結、更新觸發、涵蓋限制與未解決風險,不把未經限定的圖當成完整地圖。
先準備
貓會向你要的輸入。
- 儲存庫與版本
- 架構問題與範圍
- 可用的程式碼與歷史存取
- 預期受眾與更新負責人
路由器 + 一份 playbook
先路由。只選一份。
Cat Paw 每次任務只載入一份 playbook,不合併多份。先走這個路由器;其餘路徑是此 workflow 可檢查的候選。
- 路由器:
code-graph-pack skills/code-graph-pack/repository-architecture-graph/SKILL.md
界線
界線跟著提示一起走。
- 開始前先核實實際的工具、帳戶、權限與工作區;絕不聲稱擁有不可用的工具、帳戶、來源或能力。
- 私有程式碼、成品、即時探測或非公開資料請使用 Latch/target-workspace;若無法存取,就在邊界停下並回報阻礙,不可改用猜測。
- 任何有後果的外部行動前先暫停並取得明確核准;回傳證據、未解決風險、假設,以及仍在等待核准的行動。
完成代表
一個可核對的終點。
有版本的儲存庫架構圖譜把已核實元件與流程連到原始碼證據、負責人、測試、信心、涵蓋限制與未解決風險。
來源
這個流程從哪來。
- github.com/Graphify-Labs/graphify/tree/4c735618f3d56fd622c2049771584621c31ba9ff/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
來源確立 workflow 的模式。若有 Reddit 或社群貼文,視為實務軼事,不是普遍事實。