领域知识文档

概述

本技能用于为 Go 后端项目的整个领域（domain）生成标准化的 README.md 文档，沉淀领域级别的业务知识。文档涵盖领域名称、职责、业务场景、包含的所有业务模型、模型关联关系、领域能力汇总等核心信息。

使用场景

• •为新创建的领域目录编写 README.md
• •更新现有领域的业务文档
• •梳理领域内的所有业务模型和它们之间的关系
• •汇总领域对外提供的所有能力
• •记录领域与其他领域的依赖关系

文档结构

领域 README.md 应包含以下章节：

1. 领域概述

• •领域名称：中文名称和英文标识
• •领域职责：该领域负责的核心业务范围
• •业务场景：典型使用场景描述

2. 领域边界

• •领域内包含的业务模型清单
• •领域与其他领域的关系（依赖/被依赖）

3. 业务模型

列出领域内所有业务模型的概要信息：

• •模型名称、英文标识
• •对应表名
• •核心职责
• •关键字段（简要）

4. 模型关联关系

• •领域内模型之间的关系（ER图）
• •与其他领域模型的关系
• •关系类型说明（一对一、一对多、多对多）

5. 领域能力汇总

5.1 常规能力（所有模型通用）

• •Create、Update、Delete
• •GetById、List、Count

5.2 定制化能力（按模型分组）

• •Model A 特有能力
• •Model B 特有能力
• •...

5.3 领域对外接口

• •API 接口汇总
• •Logic 层能力汇总

6. 数据库表清单

• •所有表的列表
• •表之间的关系说明

工作流程

1. •

   扫描领域目录

   • •遍历 domain/[领域]/ 下的所有子目录
   • •识别每个业务模型（model/、category/、tag/ 等）
2. •

   汇总模型信息

   • •读取每个模型的 model.go 获取概要信息
   • •记录模型之间的关联关系
3. •

   梳理模型关系

   • •识别外键关联
   • •绘制 ER 关系图
4. •

   汇总能力清单

   • •收集所有模型的常规能力
   • •收集所有模型的定制化能力
   • •按模型分组整理
5. •

   生成文档

   • •按标准结构编写 README.md
   • •使用表格和图表清晰展示

参考

• •领域文档模板 - README.md 标准模板
• •领域分析指南 - 如何分析整个领域
• •示例文档 - 完整的领域文档示例

注意事项

1. •领域文档关注"整体"而非"细节"，具体字段定义在业务模型文档中
2. •保持与实体文档（entity-knowledge-doc）的关联引用
3. •模型关系图使用 Mermaid 语法
4. •使用中文编写，保持术语统一
5. •当新增/删除业务模型时，需同步更新本文档