快速开始¶
本页给三类读者各给一条最短成功路径:新项目、存量项目、架构设计者。每条路径只列必做动作与验证命令,深入细节转到对应文档。
新项目:生成骨架¶
目标是从零拿到一个符合 Foundation 契约的项目骨架。
npm install --save-dev skill-family-engineering-kit
npm exec -- skill-family-kit scaffold --root ./my-project --project-id my-project
npm exec -- skill-family-kit check --root ./my-project
以上命令先生成骨架,再对生成结果做工程诊断。scaffold 只写空目标目录,非空或冲突目标会被拒绝且不被触碰;check 只诊断不修复。验证以 check 退出码 0 为通过。
存量项目:只读盘点¶
目标是先看清存量仓能否采用,不改动任何字节。
npm exec -- skill-family-kit adopt-plan --root ./existing-repo
npm exec -- skill-family-kit check --root ./existing-repo
adopt-plan 输出现状、目标 Profile、精确写集、冲突与旧实现退出清单,且对输入仓字节零变化。check 只做只读诊断。确认盘点结果后再决定是否执行写入。
架构设计者:判定归属¶
目标是判断一个架构需求该落在 Foundation 哪一层,还是留在消费者。
- 读
docs/agents/architecture-routing.md的八步决策顺序。 - 在
docs/agents/capability-catalog.json按layer与intent找到能力,读它的entrypoints、sideEffects、failureSemantics、ownedByCaller。 - 需要发布、任务生命周期或制品关系时,分别转 release-skill、loop-agent、artifact-graph。
路由的硬边界:Foundation 不拥有远端写入、业务状态机、模型编排与领域审计语义。落入
keep-business或foundation-gap的能力不强行扩张 Foundation。
权威事实与规范¶
- 当前产品状态(版本、包集合、镜像坐标、门禁):当前产品状态(唯一状态页,本页不复制)。
- 开发与提交规范:Git 生命周期指南。
路径对照¶
| 读者 | 起点 | 下一步 |
|---|---|---|
| 新项目 | scaffold |
check → 接入 Profile |
| 存量项目 | adopt-plan |
分类(direct-adoption / compatibility-layer / keep-business / foundation-gap)→ 采用 |
| 架构设计者 | 路由决策 | 能力目录 → 真实导出与测试 |