103 lines
3.0 KiB
Markdown
103 lines
3.0 KiB
Markdown
|
---
|
|||
|
|
name: 规范文档创建
|
|||
|
|
overview: 创建两个规范文档：一个数据库设计规范文档，一个管理后台配置规范文档（包含admin.json和rule.json的配置说明），并在README.md中添加链接。
|
|||
|
|
todos:
|
|||
|
|
- id: create-db-doc
|
|||
|
|
content: 创建 docs/DatabaseDesign_数据库设计规范.md
|
|||
|
|
status: pending
|
|||
|
|
- id: create-admin-doc
|
|||
|
|
content: 创建 docs/AdminConfig_管理后台配置规范.md
|
|||
|
|
status: pending
|
|||
|
|
- id: update-readme
|
|||
|
|
content: 在 README.md 文档表格中添加两个新文档链接
|
|||
|
|
status: pending
|
|||
|
|
dependencies:
|
|||
|
|
- create-db-doc
|
|||
|
|
- create-admin-doc
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# 创建规范文档
|
|||
|
|
|
|||
|
|
## 任务概述
|
|||
|
|
|
|||
|
|
在 `D:\work\hotimev1.5\docs` 目录下创建两个规范文档，并更新 README.md 添加链接。
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 文档一：数据库设计规范
|
|||
|
|
|
|||
|
|
**文件**: [docs/DatabaseDesign_数据库设计规范.md](docs/DatabaseDesign_数据库设计规范.md)
|
|||
|
|
|
|||
|
|
### 内容结构
|
|||
|
|
|
|||
|
|
| 章节 | 内容 |
|
|||
|
|
|
|||
|
|
|------|------|
|
|||
|
|
|
|||
|
|
| 表命名规则 | 不加前缀、可用简称、关联表命名（主表_关联表） |
|
|||
|
|
|
|||
|
|
| 字段命名规则 | 主键id、外键表名_id、全局唯一性要求、层级字段（parent_id/parent_ids/level） |
|
|||
|
|
|
|||
|
|
| 注释规则 | select类型格式（`状态:0-正常,1-异常`）、时间用datetime |
|
|||
|
|
|
|||
|
|
| 必有字段 | state、create_time、modify_time |
|
|||
|
|
|
|||
|
|
| 示例 | 完整建表SQL示例 |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 文档二：管理后台配置规范
|
|||
|
|
|
|||
|
|
**文件**: [docs/AdminConfig_管理后台配置规范.md](docs/AdminConfig_管理后台配置规范.md)
|
|||
|
|
|
|||
|
|
### 内容结构
|
|||
|
|
|
|||
|
|
| 章节 | 内容 |
|
|||
|
|
|
|||
|
|
|------|------|
|
|||
|
|
|
|||
|
|
| admin.json 配置 | |
|
|||
|
|
|
|||
|
|
| - flow配置 | 数据流控制，定义表间权限关系（sql条件、stop标志） |
|
|||
|
|
|
|||
|
|
| - labelConfig | 操作按钮标签（show/add/delete/edit/info/download） |
|
|||
|
|
|
|||
|
|
| - label | 菜单/表的显示名称 |
|
|||
|
|
|
|||
|
|
| - menus配置 | 菜单结构（嵌套menus、icon、table、name、auth） |
|
|||
|
|
|
|||
|
|
| - auth配置 | 权限数组（show/add/delete/edit/info/download） |
|
|||
|
|
|
|||
|
|
| - icon配置 | 菜单图标（如Setting） |
|
|||
|
|
|
|||
|
|
| - table/name配置 | table指定数据表，name用于分组标识 |
|
|||
|
|
|
|||
|
|
| - stop配置 | 不允许用户修改自身关联数据的表 |
|
|||
|
|
|
|||
|
|
| rule.json 配置 | |
|
|||
|
|
|
|||
|
|
| - 字段默认权限 | add/edit/info/list/must/strict/type 各字段含义 |
|
|||
|
|
|
|||
|
|
| - 内置字段规则 | id、parent_id、create_time、modify_time、password等 |
|
|||
|
|
|
|||
|
|
| - type类型说明 | select/time/image/file/password/textArea/auth/form等 |
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 更新 README.md
|
|||
|
|
|
|||
|
|
在文档表格中添加两个新链接：
|
|||
|
|
|
|||
|
|
```markdown
|
|||
|
|
| [数据库设计规范](docs/DatabaseDesign_数据库设计规范.md) | 表命名、字段命名、注释规则、必有字段 |
|
|||
|
|
| [管理后台配置规范](docs/AdminConfig_管理后台配置规范.md) | admin.json、rule.json 配置说明 |
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 关键参考文件
|
|||
|
|
|
|||
|
|
- [`code/config.go`](code/config.go): RuleConfig 默认规则定义
|
|||
|
|
- [`code/makecode.go`](code/makecode.go): 外键自动关联逻辑
|
|||
|
|
- [`example/config/admin.json`](example/config/admin.json): 完整配置示例
|
|||
|
|
- [`example/config/rule.json`](example/config/rule.json): 字段规则示例
|