需求
This commit is contained in:
@@ -16,6 +16,7 @@
|
||||
- **读写**:PowerShell/脚本读取项目文件必须显式指定 `-Encoding utf8`
|
||||
- **画图**:优先使用 `mermaid flowchart `
|
||||
- **对话/文档编写**:必须是 中文为主体语言,技术术语保留英文原文
|
||||
- **git push**:每次 push 的时候,如果当前是子分支就合并到主分支上
|
||||
|
||||
## 项目架构
|
||||
- **技术栈**:本项目为 `Go` 服务端,基于 `gin-vue-admin` 体系;Web 框架使用 `Gin`,ORM 使用 `GORM`,配置使用 `Viper`,日志使用 `Zap`,鉴权与权限控制使用 `JWT + Casbin`,接口文档使用 `Swagger`,缓存优先使用 `Redis`;关系型数据库统一通过 `GORM` 接入,数据库使用 `PostgreSQL` ;按配置可启用 `MongoDB`、`cron`、`Excelize`、多云 `OSS/S3`,部署默认支持 `Docker`。
|
||||
@@ -102,11 +103,11 @@ flowchart LR
|
||||
| `.ai-specs\coding-specs\sys-params.md` | 规定 `sys_params` 的读写方式与单参数独立 API 的封装方式 | 涉及系统参数读写、基于 `sys_params` 封装业务配置接口时必读 |
|
||||
| `.ai-specs\coding-specs\vo-model-request-response.md` | 规定项目中实体、API 入参、API 出参与通用结构在 `model` 体系内的落点与复用边界 | 涉及 `vo` 放置方式、是否复用实体、何时新增 `request/response` 结构时必读 |
|
||||
|
||||
### logic-specs 存放业务说明文档不设计代码
|
||||
### requirements 存放需求草案文档
|
||||
|
||||
| 路径 | 用途 | 说明 |
|
||||
|:---|:---|:---|
|
||||
| `.ai-specs\logic-specs\book.md` | 记录书籍相关主体与字段草案 | 涉及书籍、书籍系列、书籍作者、书籍评论等业务设计时先读 |
|
||||
| `.ai-specs\requirements\book.md` | 记录书籍需求草案,先列相关表和字段,再列业务需求描述 | 涉及书籍、书籍系列、书籍作者、书籍评论等业务设计时先读 |
|
||||
|
||||
### sys-specs 存放系统级文档
|
||||
|
||||
@@ -115,6 +116,7 @@ flowchart LR
|
||||
| `.ai-specs\sys-specs\business-table-spec.md` | 规定新增业务表的 SQL 设计、索引、约束、迁移和兼容要求 | 涉及新增/修改业务表、字段、索引、唯一约束、迁移注册时必读 |
|
||||
| `.ai-specs\sys-specs\business-dictionary-spec.md` | 规定新增业务字典的定义方式,以及代码枚举与字典值的一一对应关系 | 涉及新增业务状态、类型、级别、来源、模式、分类等值域时必读 |
|
||||
| `.ai-specs\sys-specs\module-naming-spec.md` | 规定业务模块中文名与英文名的统一登记方式 | 涉及新增/修改业务模块命名、中英文对照、目录命名时必读 |
|
||||
| `.ai-specs\sys-specs\requirements-stage-spec.md` | 规定 `requirements` 需求草案阶段的文档边界、结构和输出方式 | 涉及新增/修改 `.ai-specs\requirements\*.md` 时必读 |
|
||||
|
||||
### doc-api <admin or app or `平台`>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user