每個項目都有兩套知識:寫在文檔裏的,和藏在人腦子裏的。新人或智能體接手時,往往在“潛規則”上花費大量時間,而不是在閱讀 README。onboarding-pack 旨在將這第二套知識顯性化,讓 agent 或人類在 10 分鐘內掌握項目的核心上下文。
這是什麼¶
這是一個記憶類插件,由 ChenneyZhuang 維護。它將項目中的隱性知識文檔化,幫助新成員快速理解項目的運行機制、權威來源及內部規則。
核心功能¶
插件採用固定的五節結構,總閱讀時間約 10 分鐘:
- What & why:簡短說明項目是什麼、服務對象以及“完成”的標準。
- Run it:提供生成可工作設置的確切命令。
- Map:明確資源存放位置及權威來源(每個項目通常存在多個相互衝突的信息源,需指明贏家)。
- Unwritten rules:列出內部默認規則(通常爲 5 條左右),這些規則對內部人員顯而易見,但對新人不可見(例如“絕不能直接編輯 X 文件”)。
- Who & where:列出負責人、決策論壇及提問渠道。
安裝與啓用¶
使用官方安裝命令添加該插件:
npx skills add ChenneyZhuang/onboarding-pack
當前版本爲 v0.1.0,許可證爲 MIT。
典型用法¶
- 快速獲取環境:直接運行插件提供的命令,獲取可工作的項目設置。
- 建立審計循環:遵循“新人提問 → 新增條目”的循環。潛規則在初次編寫時必然有遺漏,需在後續工作中不斷補充和修正。
適用場景與注意¶
- 適用場景:適合項目交接、新人入職或智能體接入複雜遺留系統。
- 維護規則:包必須隨項目變化更新。如果包的更新滯後於項目大版本變更,應當被懷疑。
- 權限注意:插件以當前 DSH 進程權限運行,安裝前建議檢查源碼與許可證。
通過記錄這些隱性知識,onboarding-pack 將原本需要花費數週的摸索時間,壓縮爲一次性的文檔閱讀成本。