SuperAPI AI 工具集

uw-analyze-domain

编程与开发

查看项目

更新于 10-30 09:34

技能介绍

用途

uw-analyze-domain 用于分析领域模型,聚焦代码中编码的领域实体、值对象、聚合与业务规则。其分析结果输出到 docs/unwind/layers/domain-model/ 文件夹,包含 index.md 和若干分节文件。

主要能力

  • 生成领域模型文档结构:index.md(概览、实体数量、分节链接)、entities.md(全部实体定义)、value-objects.md(值对象、可嵌入类型)、enums.md(全部枚举/联合类型)、validation.md(校验规则、约束、状态机)。
  • 对大型代码库(20 个以上实体),按聚合或领域拆分文件,例如 users-aggregate.md、orders-aggregate.md。
  • 保留实际类定义与注解,并链接到源码文件位置。
  • 提取状态机,可用 Mermaid 状态图表示状态迁移并标注源码行号。
  • 输出校验约束表(字段、类型、最小值、最大值、是否必填、默认值、备注)。
  • 记录全部枚举/联合类型及其每个值的说明。
  • 记录角色-权限矩阵与自引用约束(例如某对象不能向自身汇报、结束日期必须晚于开始日期)。
  • 对每个实体、枚举和校验规则标注 [MUST]、[SHOULD] 或 [DON'T]。

使用方式

技能按增量写入流程执行:

  1. 创建目录 mkdir -p docs/unwind/layers/domain-model/,写入初始 index.md。
  2. 查找全部实体类,写入 entities.md,并更新 index.md。
  3. 查找可嵌入类型与值对象,写入 value-objects.md,并更新 index.md。
  4. 查找全部枚举/联合类型并记录取值,写入 enums.md,并更新 index.md。
  5. 提取校验逻辑与状态机,写入 validation.md,并更新 index.md。
  6. 最终更新 index.md,补全计数与摘要。

若 docs/unwind/layers/domain-model/ 已存在,则进入刷新模式:比较当前状态并在 index.md 中添加“## Changes Since Last Review”章节。

输出标注规则

默认分类为:[MUST] 用于实体、校验规则、枚举、业务约束;[SHOULD] 用于 DTO、映射器、工具类型;[DON'T] 用于框架特定装饰器、ORM 注解。具体标注规则参见 analysis-principles.md 第 9 节。

适用场景

适用于需要从代码库中系统梳理领域模型、沉淀结构化文档的工程场景,尤其是包含较多实体、值对象、枚举与校验逻辑的业务系统。

限制

资料未提供该技能的具体安装方式、运行命令、支持的编程语言范围、收费与平台信息,这些事实暂未提供。