From team-standards
Generates progressive project knowledge graphs and documentation in four phases, covering architecture, modules, business flows, and deep module docs. Supports automatic and manual confirmation modes.
How this skill is triggered — by the user, by Claude, or both
Slash command
/team-standards:init-project-docsThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
用户说以下任意一种时,**必须**调用本 skill:
architecture-template.mddevelopment-reference-template.mdoverview-template.mdtemplates/00_project_overview.mdtemplates/01_architecture_overview.mdtemplates/02_module_map.mdtemplates/03_business_flow_map.mdtemplates/04_data_model_map.mdtemplates/05_api_map.mdtemplates/06_frontend_backend_mapping.mdtemplates/07_glossary.mdtemplates/08_constraints_and_rules.mdtemplates/09_refactor_plan.mdtemplates/10_change_log.mdtemplates/flutter_skill.mdtemplates/module_template.mdtemplates/springcloud_skill.mdtemplates/vue_skill.md用户说以下任意一种时,必须调用本 skill:
知识图谱不是一次性生成的,而是分 4 个阶段逐步丰富。每个阶段的文档为下一阶段提供上下文。
| 阶段 | 生成内容 | 数据来源 | 默认模式 |
|---|---|---|---|
| Phase 1 | 项目概要 + 架构总览 + 架构约束 | 扫描代码结构 + 构建文件 | 自动 |
| Phase 2 | 模块地图 + 数据模型 + API 总表 + 前后端映射 | 扫描 Controller/Entity/Mapper | 自动 |
| Phase 3 | 业务流程 + 术语表 + 重构计划 + 变更记录 | AI 分析 + 人工确认 | 可选自动/确认 |
| Phase 4 | 模块深度文档 + 技能卡(Flutter/Vue/Spring Cloud) | 逐模块深度扫描 | 可选自动/确认 |
本 skill 生成的全部知识图谱文档默认写入用户目录知识库,不再写入项目 docs/,避免污染源项目仓库。 与 design-doc-required / bug-doc-required / business-logic-orientation 的默认输出根保持一致。
| 项 | 值 |
|---|---|
输出根 {KG_ROOT} | {USER_DOCUMENTS}/ai-docs/{project}/ |
| 与 design / bug / orientation 的关系 | 同一个 ai-docs/{project}/ 知识库下平级共存(design/、bug/、orientation/、work-log/ 等是兄弟目录) |
项目 docs/ | 不写入。知识图谱不再随项目仓库分发,避免污染源项目 |
下文所有路径中的 {KG_ROOT}/ 一律指 {USER_DOCUMENTS}/ai-docs/{project}/。知识图谱文档之间互相引用一律使用相对文件名(如 01_architecture_overview.md、modules/{module}.md),不写 docs/ 前缀,使整套文档与所在根解耦。
兼容历史项目: 若某项目此前已把知识图谱生成在
docs/,由用户自行迁移到{KG_ROOT}/;本 skill 默认只读写{KG_ROOT}/。
flowchart TD
A([收到初始化指令]) --> B[探索项目目录结构]
B --> C[识别项目类型和技术栈]
C --> D{用户指定阶段?}
D -->|"指定了 Phase N"| E[执行指定阶段]
D -->|"未指定"| F[询问执行范围]
F --> G{"全量(Phase 1-4)\n还是仅核心(Phase 1-2)?"}
G -->|核心| H[执行 Phase 1 + 2]
G -->|全量| I[执行 Phase 1 → 2 → 3 → 4]
H --> J[输出文档清单]
I --> K{Phase 3-4 模式?}
K -->|自动| L[全自动生成]
K -->|确认| M[逐项展示内容等待确认]
L --> J
M --> J
pom.xml / build.gradle / pubspec.yaml — 获取技术栈和依赖I*.java,不读 impl)— 获取业务能力清单| 文档 | 路径 | 模板 |
|---|---|---|
| 项目概要 | {KG_ROOT}/00_project_overview.md | templates/00_project_overview.md |
| 架构总览 | {KG_ROOT}/01_architecture_overview.md | templates/01_architecture_overview.md |
| 架构约束 | {KG_ROOT}/08_constraints_and_rules.md | templates/08_constraints_and_rules.md |
参考 templates/00_project_overview.md:
参考 templates/01_architecture_overview.md:
参考 templates/08_constraints_and_rules.md:
| 文档 | 路径 | 模板 |
|---|---|---|
| 模块地图 | {KG_ROOT}/02_module_map.md | templates/02_module_map.md |
| 数据模型 | {KG_ROOT}/04_data_model_map.md | templates/04_data_model_map.md |
| API 总表 | {KG_ROOT}/05_api_map.md | templates/05_api_map.md |
| 前后端映射 | {KG_ROOT}/06_frontend_backend_mapping.md | templates/06_frontend_backend_mapping.md |
同时生成 {KG_ROOT}/development-reference.md(参考 development-reference-template.md),包含:
注意:development-reference 需要深度分析,需读取 Service impl、Component 实现、Stream handler、Configuration 类的实际代码。
此阶段的内容无法纯靠代码推断,默认需人工确认。用户可选择自动模式(AI 尽力推断,生成后用户审阅)。
| 文档 | 路径 | 模板 | 说明 |
|---|---|---|---|
| 业务流程 | {KG_ROOT}/03_business_flow_map.md | templates/03_business_flow_map.md | 核心业务流程清单和概要 |
| 术语表 | {KG_ROOT}/07_glossary.md | templates/07_glossary.md | 业务术语定义 |
| 重构计划 | {KG_ROOT}/09_refactor_plan.md | templates/09_refactor_plan.md | 重构路线和进度跟踪 |
| 变更记录 | {KG_ROOT}/10_change_log.md | templates/10_change_log.md | ADR 风格变更记录 |
Phase 1-2 已完成(需要 {KG_ROOT}/02_module_map.md 中的模块清单)。
为 {KG_ROOT}/02_module_map.md 中的每个模块生成深度文档:
路径:{KG_ROOT}/modules/{module}.md
模板:templates/module_template.md
每份模块文档包含 10 节:
| 项目类型 | 技能卡 | 路径 | 模板 |
|---|---|---|---|
| Flutter | Flutter 技能卡 | {KG_ROOT}/skills/flutter_skill.md | templates/flutter_skill.md |
| Vue | Vue 技能卡 | {KG_ROOT}/skills/vue_skill.md | templates/vue_skill.md |
| Spring Cloud/Boot | Spring Cloud 技能卡 | {KG_ROOT}/skills/springcloud_skill.md | templates/springcloud_skill.md |
技能卡包含:分层职责、命名规范、AI 代码生成规则、当前重构状态。
生成完成后,用户目录知识库 {KG_ROOT}/(= {USER_DOCUMENTS}/ai-docs/{project}/)结构如下:
{KG_ROOT}/ ← {USER_DOCUMENTS}/ai-docs/{project}/
├── 00_project_overview.md ← AI 入口(Phase 1)
├── 01_architecture_overview.md ← 系统分层(Phase 1)
├── 02_module_map.md ← 模块一览(Phase 2)
├── 03_business_flow_map.md ← 业务流程(Phase 3)
├── 04_data_model_map.md ← 数据模型(Phase 2)
├── 05_api_map.md ← API 接口(Phase 2)
├── 06_frontend_backend_mapping.md ← 前后端映射(Phase 2)
├── 07_glossary.md ← 术语表(Phase 3)
├── 08_constraints_and_rules.md ← 架构红线(Phase 1)
├── 09_refactor_plan.md ← 重构计划(Phase 3)
├── 10_change_log.md ← 变更记录(Phase 3)
├── development-reference.md ← 开发参考(Phase 2)
│
├── skills/ ← 技能卡(Phase 4)
│ ├── flutter_skill.md
│ ├── vue_skill.md
│ └── springcloud_skill.md
│
└── modules/ ← 模块深度文档(Phase 4)
├── {module_a}.md
├── {module_b}.md
└── ...
来源:team-standards Mermaid 规范
=、,、/、<、>、(、)、[、]、: 时必须加引号< > 改用文字(如:大于、小于、请求体、响应体)classDiagram 方法名不含中文I*.java),不读 impl,避免无效 token 消耗design-doc-required(本 skill 属于分析类,非开发类)project-docs-update)doc-index-required Phase-B 更新索引| Skill | 关系 |
|---|---|
project-docs-update | 本 skill 完成初始化后,后续维护由 project-docs-update 负责 |
doc-index-required | 生成文档后自动触发 Phase-B 更新索引 |
business-logic-orientation | Phase 4 模块文档可复用其产出的梳理结果 |
design-doc-required | 不触发——本 skill 属于分析类 |
arch-lint | Phase 1 的架构约束可为 arch-lint 提供检查规则基线 |
npx claudepluginhub exception-coder/team-standards --plugin team-standardsProvides behavioral guidelines to reduce common LLM coding mistakes, focusing on simplicity, surgical changes, assumption surfacing, and verifiable success criteria.
Searches, retrieves, and installs Agent Skills from prompts.chat registry using MCP tools like search_skills and get_skill. Activates for finding skills, browsing catalogs, or extending Claude.
Creates, edits, and optimizes skills for Claude Code, including drafting, evaluating with test prompts, iterating on performance, and improving skill descriptions for better triggering accuracy.