軟體工程
為新工程師建立程式碼庫導覽
以新進者為對象的導覽,從可執行路徑開始,說明儲存庫邊界與擁有權,並安排逐漸深入的程式碼閱讀練習。
流程
照這個順序做。
- 確認新工程師的角色、第一個有價值的成果、時間盒、儲存庫版本、本機前置條件,以及導覽要回答的問題。
- 從進入點追蹤一條安全的主要路徑到測試或成品,記錄指令、預期輸出與最小有用變更。
- 盤點主要目錄、建置與部署邊界、資料與外部系統、負責人、文件與關鍵決策。
- 建立漸進停留點,每點包含閱讀問題、小練習、驗證訊號,以及在正式環境或後果性存取前的清楚停止點。
- 加入詞彙表、權威程式碼與決策連結、常見陷阱、升級聯絡人,以及私有或非公開證據的處理指引。
- 用同事或乾淨環境的自檢驗證導覽,修正不清楚的步驟,記錄無法測試的部分。
- 發布有版本的導覽,附更新負責人、每條路徑的證據、已知限制與給未來維護者的未解決風險。
先準備
貓會向你要的輸入。
- 新工程師角色與第一個成果
- 儲存庫與本機設定說明
- 時間盒與學習限制
- 負責人與升級聯絡人
路由器 + 一份 playbook
先路由。只選一份。
Cat Paw 每次任務只載入一份 playbook,不合併多份。先走這個路由器;其餘路徑是此 workflow 可檢查的候選。
- 路由器:
codebase-knowledge-pack skills/codebase-knowledge-pack/codebase-onboarding-tour/SKILL.md
界線
界線跟著提示一起走。
- 開始前先核實實際的工具、帳戶、權限與工作區;絕不聲稱擁有不可用的工具、帳戶、來源或能力。
- 私有程式碼、成品、即時探測或非公開資料請使用 Latch/target-workspace;若無法存取,就在邊界停下並回報阻礙,不可改用猜測。
- 任何有後果的外部行動前先暫停並取得明確核准;回傳證據、未解決風險、假設,以及仍在等待核准的行動。
完成代表
一個可核對的終點。
有版本的入職導覽能帶新工程師從已核實的可執行路徑深入理解儲存庫,並記錄擁有權、練習、證據與未解決風險。
來源
這個流程從哪來。
- github.com/Egonex-AI/Understand-Anything/tree/6df3065f1d8ddc2ce3615314d1d493f36d6b1c80/
- c4model.com/
- docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
來源確立 workflow 的模式。若有 Reddit 或社群貼文,視為實務軼事,不是普遍事實。