每个项目都有两套知识:写在文档里的,和藏在人脑子里的。新人或智能体接手时,往往在“潜规则”上花费大量时间,而不是在阅读 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 将原本需要花费数周的摸索时间,压缩为一次性的文档阅读成本。