中文 | English
从一句话项目描述出发,通过问答或配置单,快速生成符合 AI 团队协作规范(SDD 六阶段) 的项目根目录骨架。
/project-spark 我要做一个智慧校园后台管理系统
Skill 会自动进入 3 轮问答,收集项目身份 → 架构选型 → AI 协作偏好,最终生成完整项目骨架。
/project-spark --config ./project-init.json
提前填好 project-init.json(参考 templates/project-init.example.json),跳过问答直接渲染。
执行完成后,目标目录将包含:
<your-project>/
├── AGENTS.md ← 3 层拼装(全局继承 + 6 条款 + 项目专属)
├── CLAUDE.md ← Claude Code 专属指令
├── README.md ← 项目说明(自动填充字段)
├── .gitignore ← Java/Vue/Node 混合忽略规则
├── .claude/
│ └── settings.local.json
├── .project-init.json ← 配置快照(便于追溯)
├── docs/ ← SDD 六阶段 + LLM-Wiki 知识库
│ ├── 0.0项目会话记录/
│ │ └── 会话记录.txt ← 种子会话,含所有决策字段
│ ├── 1.0产品调研/ ← 含立项书/计划/PRD 三份模板 + 参考材料//UI设计描述/
│ ├── 2.0需求分析/
│ ├── 3.0测试案例/
│ ├── 4.0需求实施/
│ ├── 5.0功能测试/
│ ├── 6.0项目管理/
│ ├── README.md ← 三层架构总览(Raw/LLM-Wiki/views)
│ └── LLM-Wiki/ ← AI 唯一可写区(仅对项目文档生效,不对代码)
│ ├── AGENTS.md / SCHEMA.md / README.md
│ ├── index.md / overview.md
│ ├── summaries/ concepts/ synthesis/ queries/ views/
│ └── entities/{modules,services,tables,apis,roles}/
├── <nameEn>-service/ ← [可选] 芋道后端骨架 + 批量改名
├── <nameEn>-ui-admin/ ← [可选] 前端 admin 骨架
└── <nameEn>-ui-member/ ← [可选] 前端会员端骨架
project-spark/
├── SKILL.md ← Skill 入口(通用,Claude Code / Qoder / Trae / Codex CLI / Cursor 等均可识别)
├── README.md ← 你正在看的这个文件
├── references/ ← 知识库
│ ├── field-dict.md ← 13 个字段定义 + 默认值推断
│ ├── naming-rules.md ← 命名正则 + 示例
│ ├── yudao-source-list.md ← 芋道 git 源清单
│ └── agents-md-snippets/ ← AGENTS.md 条款片段库
│ ├── README.md
│ ├── core-sdd.md ← SDD 六阶段规范
│ ├── progressive-disclosure.md ← 渐进式披露
│ ├── memory-bootstrap.md ← 主动记忆
│ ├── gitnexus-workflow.md ← GitNexus 工作流(代码层)
│ ├── llm-wiki.md ← LLM-Wiki 文档编译器(文档层)
│ └── testing-guardrail.md ← 双 Agent 对抗测试
├── templates/ ← 模板文件
│ ├── AGENTS.md.tpl
│ ├── CLAUDE.md.tpl
│ ├── README.md.tpl
│ ├── .gitignore.tpl
│ ├── claude-settings.json.tpl
│ ├── project-init.example.json ← 配置单示例
│ └── docs-scaffold/ ← docs/ 种子模板
│ ├── README.md.tpl ← docs 根 · 三层架构总览
│ ├── 0.0项目会话记录/
│ ├── 1.0产品调研/ ← 含 {{nameZh}}-立项书/计划/PRD.md.tpl + 参考材料//UI设计描述/
│ ├── 2.0需求分析/
│ ├── 3.0测试案例/
│ ├── 4.0需求实施/
│ ├── 5.0功能测试/
│ ├── 6.0项目管理/
│ └── LLM-Wiki/ ← 知识库编译器骨架(仅对文档生效)
│ ├── AGENTS.md.tpl
│ ├── SCHEMA.md
│ ├── README.md.tpl / index.md.tpl / overview.md.tpl
│ └── entities/ summaries/ concepts/ …
├── scripts/ ← 执行脚本
│ ├── render_root.py ← 根目录渲染引擎
│ ├── clone_and_rename.py ← git clone + 批量改名
│ └── validate.py ← 配置校验
└── bundled-skills/ ← 内置 Skill(开箱即用)
├── read-drawio/ ← Draw.io 流程图解析
│ ├── SKILL.md / REFERENCE.md / EXAMPLES.md
│ ├── scripts/read_drawio.py
│ └── templates/
└── db-query/ ← Oracle 通用查询(DDL/数据/行数/字段/搜索)
├── SKILL.md
└── scripts/db_query.py
# 1. 校验配置
python scripts/validate.py ./project-init.json
# 2. 渲染根目录
python scripts/render_root.py ./project-init.json
# 3. [可选] 拉取代码骨架
python scripts/clone_and_rename.py ./project-init.json| 理念 | 说明 |
|---|---|
| 项目根目录编排器 | 只搭建根目录 + docs,不自维护 Java/Vue 模板代码 |
| git clone + 批量改名 | 代码骨架直接从芋道社区拉取,省去同步维护成本 |
| AGENTS.md 3 层拼装 | 全局规则继承 + 可插拔条款片段 + 项目专属配置 |
| 双触发模式 | B 引导式(适合新手)/ C 配置单(适合批量 / 老手) |
| AI 协作规则自动注入 | 将团队 AI 协作最佳实践(SDD、渐进式披露、主动记忆等)沉淀为可复用条款 |
| 文档/代码双通道 | 文档层 → docs/LLM-Wiki/(知识库编译器);代码层 → GitNexus(调用链/爆炸半径),不跨界 |
详见 references/field-dict.md,核心字段:
| 字段 | 示例 | 说明 |
|---|---|---|
identity.nameZh |
智慧校园 | 中文项目名 |
identity.nameEn |
smart-campus | 英文名(目录名/模块名前缀) |
identity.groupId |
com.school | Maven groupId |
identity.javaPackage |
com.school.campus | Java 包名 |
backend.action |
clone / skip | 是否拉取后端骨架 |
frontend.admin.action |
clone / skip | 是否拉取 admin 前端 |
frontend.member.action |
skip | 会员端默认跳过 |
| 版本 | 说明 |
|---|---|
| v0.4 | 文档沉淀:AI 协作最佳实践 → AGENTS.md 条款片段、主动记忆 bootstrap、LLM-Wiki 文档层知识库(仅对项目文档生效) |
| v0.3 | 双触发模式(引导式 + 配置单) |
| v0.2 | git clone + 批量改名引擎 |
| v0.1 | 基础根目录渲染 |