业务模型知识文档

概述

本技能用于为 Go 后端项目的单个业务模型（实体）生成标准化的 README.md 文档。文档涵盖实体结构、字段定义、数据库表结构、业务能力等核心信息，帮助理解和维护单个业务模型。

使用场景

• •为新创建的业务模型目录编写 README.md
• •更新现有业务模型的文档
• •记录单个模型的字段和能力清单
• •生成 SQL 建表语句文档

文档结构

业务模型 README.md 应包含以下章节：

1. 模型概述

• •模型名称：中文名称和英文标识
• •所属领域：属于哪个 domain
• •对应表名：数据库表名
• •模型职责：该模型负责的业务范围

2. 实体定义

• •结构体名称
• •继承关系（如 base.BaseModel）
• •字段列表（含类型、tag、注释）

3. 字段说明

4. 业务能力

4.1 常规能力（继承自 base.BaseModel）

• •Create：创建记录
• •Update：更新记录
• •Delete：删除记录
• •GetById：根据ID查询
• •List：分页列表查询
• •Count：统计记录数

4.2 定制化能力

模型特有的业务能力，例如：

• •Publish：发布
• •GetByCode：根据编码查询
• •UpdateStatus：状态变更

5. 数据库表结构

• •完整 SQL 建表语句
• •索引定义
• •外键关系

6. 关联关系

• •与哪些模型有关联
• •关联类型（一对一、一对多、多对多）

工作流程

1. •

   分析模型代码

   • •读取 model.go 中的实体定义
   • •识别字段结构、类型、tag、注释
2. •

   提取能力信息

   • •从 abilitys.go 中提取自定义方法
   • •识别常规能力和定制化能力
3. •

   生成文档

   • •按标准结构编写 README.md
   • •生成 SQL 建表语句
   • •使用表格清晰展示
4. •

   验证完整性

   • •检查字段是否完整
   • •验证能力清单

参考

• •模型文档模板 - README.md 标准模板
• •字段分析指南 - 如何分析模型字段
• •示例文档 - 完整的业务模型文档示例

注意事项

1. •文档应保持与代码同步更新
2. •表结构变更时需同步更新 SQL 语句
3. •使用中文编写，保持术语统一
4. •每个业务模型独立文档，不涉及其他模型细节