93 lines
3.9 KiB
Markdown
93 lines
3.9 KiB
Markdown
# DomainMap Skill
|
||
|
||
业务领域知识图谱生成技能 - 从业务文档提取结构化领域知识。
|
||
|
||
> **权威定义见 [SKILL.md](./SKILL.md)**（等级体系、输出结构、Phase 流程、CodeMap 交叉引用均以 SKILL.md 为准）。本文档仅提供快速上手说明。
|
||
|
||
**核心精神**: 于细微处发大隙 - 流程必须标注所有"分支点"，状态机必须列举所有状态及其可执行操作
|
||
|
||
**验证纲领**: 实践才能检验真理 - 运行态采集（D4 可选扩展）须有截图等证据，无证据的转换标记为"推测"
|
||
|
||
## 概述
|
||
|
||
DomainMap 与 CodeMap 形成互补：CodeMap 回答"系统能做什么"（来自代码仓库），DomainMap 回答"系统应该怎么做"（来自业务文档）。
|
||
|
||
## 使用方法
|
||
|
||
```bash
|
||
# 交互式初始化（推荐）
|
||
/sn-domainmap
|
||
|
||
# 指定文档目录
|
||
/sn-domainmap /path/to/docs
|
||
|
||
# 指定输出目录（产物写入 {output}/domainmap/）
|
||
/sn-domainmap /path/to/docs --output /path/to/output
|
||
|
||
# 指定分析等级（D1 快速扫描 / D2 标准分析 / D3 完整生成）
|
||
/sn-domainmap /path/to/docs --level D3
|
||
|
||
# 与 CodeMap 建立交叉引用
|
||
/sn-domainmap /path/to/docs --link-codemap /path/to/codemap
|
||
```
|
||
|
||
支持的文档类型、输出结构、等级定义与 CodeMap 交叉引用矩阵见 SKILL.md。
|
||
|
||
## 核心概念
|
||
|
||
### 业务实体 (Entity)
|
||
|
||
核心业务对象的定义，包含业务定义、状态机（状态与流转）、关键字段、与代码 Entity/DTO/VO 的对应关系。
|
||
|
||
### 业务流程 (Process)
|
||
|
||
工作流程的阶段定义（角色、动作、输入输出）与 Mermaid 流程图。
|
||
|
||
### 业务规则 (Rule)
|
||
|
||
分三类：validation（校验）、calculation（计算）、transition（流转）。产物采用 rule_set 包装结构（见 `templates/rule.template.yaml` 与 `schemas/domainmap.rule.schema.json`）。
|
||
|
||
### 术语表 (Glossary)
|
||
|
||
业务专有名词定义，按业务域分文件存放于 `glossary/terms/{domain}-terms.yaml`，含别名、使用上下文、与代码枚举的对应。
|
||
|
||
## D4 可选扩展
|
||
|
||
`screen_flows/`（页面流程）、`config_impact/`（配置影响）、`runtime/`（运行态事实）与深度交叉引用为按需扩展：模板备于 `templates/`，executor 不内置生成步骤。其中 `runtime/` 采集依赖 chrome-devtools MCP，不可用时跳过。
|
||
|
||
## 应用场景
|
||
|
||
1. **需求影响分析**：从 DomainMap 定位受影响业务对象，经交叉引用进入 CodeMap 展开调用链
|
||
2. **智能 PRD 生成**：业务流程/规则 + CodeMap 接口定义，自动填充技术实现参考
|
||
3. **Bug 追踪定位**：堆栈 → CodeMap 符号 → 交叉引用 → 业务流程与规则约束
|
||
|
||
## 文件说明
|
||
|
||
```
|
||
domainmap/
|
||
├── SKILL.md # Skill 入口定义（权威）
|
||
├── executor.yaml # 执行引擎（v3.0）
|
||
├── README.md # 本文档
|
||
├── schemas/ # JSON Schema 校验定义（9 个）
|
||
│ ├── domainmap.index.schema.json
|
||
│ ├── domainmap.entity.schema.json
|
||
│ ├── domainmap.process.schema.json
|
||
│ ├── domainmap.rule.schema.json
|
||
│ ├── domainmap.glossary.schema.json
|
||
│ ├── domainmap.xref.schema.json
|
||
│ ├── domainmap.screen_flow.schema.json # D4 可选扩展
|
||
│ ├── domainmap.config_impact.schema.json# D4 可选扩展
|
||
│ └── domainmap.runtime.schema.json # D4 可选扩展
|
||
└── templates/ # YAML 模板（16 个）
|
||
├── _index / _entities_index / _processes_index / _rules_index / _glossary_index / _xrefs_index .template.yaml
|
||
├── entity / process / rule / glossary .template.yaml
|
||
├── xref-entity-to-code / xref-process-to-api / xref-term-to-symbol .template.yaml
|
||
└── screen_flow / config_impact / runtime .template.yaml # D4 可选扩展
|
||
```
|
||
|
||
## 相关文档
|
||
|
||
- [CodeMap Skill](../codemap/README.md)
|
||
|
||
当前版本：v3.0
|