AgentSkillsCN

Back Design Skill

后端设计技能

SKILL.md

Back Design Skill

根据需求生成后端设计文档。

何时使用

  • 当用户需要创建后端设计文档时
  • 当用户输入 "后端设计"、"API设计"、"数据库设计" 等意图时
  • 当有新功能需要设计后端实现方案时

能力

此 Skill 可以:

  1. 收集和分析需求
  2. 设计 Prisma 数据模型
  3. 定义 Proto 类型
  4. 设计 DTO 和接口
  5. 设计权限控制
  6. 描述业务规则

后端 6-Step 开发流程

设计文档需涵盖以下 6 个步骤:

  1. 需求设计与架构规划

    • 功能需求分析
    • 系统架构设计
    • 依赖模块识别
  2. Prisma 数据模型设计

    • 模型定义(字段、类型、默认值)
    • 关系设计(一对一、一对多、多对多)
    • 索引优化
  3. 定义 Proto 类型

    • protos/ 目录定义 proto 文件
    • 运行 pnpm run proto:gen 生成 TypeScript 类型到 src/shared/
  4. Service 层设计

    • 核心业务逻辑描述
    • 数据查询策略
    • 异常处理规则
  5. Controller 层设计

    • API 路径规划
    • HTTP 方法选择
    • Swagger 文档注释
  6. 模块配置设计

    • 模块依赖关系
    • 初始化逻辑
    • 注册配置

设计内容规范

1. 数据库设计 (Prisma Schema)

  • 主键策略(UUID / 自增 / 业务主键)
  • 字段类型选择
  • 关系设计(@relation, 级联操作)
  • 索引优化(@@index)
  • 表名映射(@@map)

2. Proto 类型定义

  • protos/ 目录定义 proto 文件
  • 生成 TypeScript 类型到 src/shared/

3. DTO 设计

  • 使用 class-validator 装饰器
  • 区分必填/可选字段
  • 合理的校验规则

4. 接口设计

  • RESTful API 规范
  • 权限控制设计
  • 请求/响应格式

5. 业务规则设计

  • 核心业务逻辑描述
  • 状态流转规则
  • 数据校验规则

文档规范

  • 存储: docs/design-docs/
  • 命名: 中文文件名,主需求_模块
  • 拆分: 按主功能模块拆分文档