书籍模块
This commit is contained in:
@@ -1,10 +1,10 @@
|
||||
# AI 开发入口 [!IMPORTANT]
|
||||
# AI 开发入口 [!IMPORTANT]
|
||||
|
||||
- **本文档要求**:本文档为项目级别规范和重要导航,必须严格参考
|
||||
- **本文档要求**:本文档只允许在已有的结构上CURD,不允许增加其他标题区
|
||||
- **本文档要求**:.ai-specs 目录下新增/删除任何文档的时候都应该 在本文档中修改 `## 项目文档`
|
||||
- **文档要求**:规范型文档是给 AI 的顶层入口文档,不是“解释得更全”就更好,而是要 更短、更硬、更可判定
|
||||
- **文档要求**:如果我的`需求/要求`和`规范文档`冲突,你应该及时提醒我,让我决策是修正`需求/规范文档`
|
||||
- **文档要求**:规范型文档是给 AI 的顶层入口文档,不是“解释得更全”就更好,而是要 更短、更硬、更可判定,推荐文档内容以“硬规则 + 模板”为主
|
||||
- **文档要求**:如果我的`需求/要求`和`规范文档`冲突,你应该及时提醒我,让我决策是否修正`需求/规范文档`
|
||||
- **代码优化**:先复用再新增,允许抽公共逻辑,但公共逻辑必须保证边界仍清晰。
|
||||
- **代码优化**:优化代码时必须同时考虑冗余、孤岛代码、代码清晰度、复杂度、边界条件和兼容性,不能只追求功能跑通。不要修改ui/ux 视觉效果,除非明确要求。
|
||||
- **代码默认遵循**:业务流程需要遵循 `主流做法` `工业级正规`
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
## 工具使用规则
|
||||
|
||||
- **搜索范围限制**:Grep/Glob 严禁全盘搜索,绝对禁止扫描 `.gitignore` 忽略的目录,以避免性能卡顿。
|
||||
- **搜索范围限制**:Grep/Glob 严禁全盘搜索,绝对禁止扫描 `server\docs`、`.worktrees`、`web\node_modules`、`web\dist`、`server\log`、`server\uploads`、`rm_file` 等大目录,以避免性能卡顿。
|
||||
- **读写**:所有文件读取/写入统一使用 UTF-8(建议无 BOM)
|
||||
- **读写**:PowerShell/脚本读取项目文件必须显式指定 `-Encoding utf8`
|
||||
- **画图**:优先使用 `Mermaid 图` 不能混入非 Mermaid 语法文本。
|
||||
@@ -134,6 +134,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\doc-api-doc-spec.md` | 规定 `doc-api` 从空文档生成接口 contract 的输入源、admin CRUD 模板、字段来源和硬性要求 | 涉及新增/修改 `.ai-specs\doc-api` 接口文档时必读 |
|
||||
| `.ai-specs\sys-specs\database-upgrade-doc-spec.md` | 规定 `.ai-transition\database-upgrade-doc` 数据库升级 SQL 的版本定位、写入时机和兼容 SQL 要求 | 涉及修改 `doc-sql` 并产生数据库结构变更、维护 `v1.sql`/`v2.sql` 等升级 SQL 时必读 |
|
||||
|
||||
### doc-api <admin or app or `平台`>
|
||||
@@ -169,7 +170,7 @@ flowchart LR
|
||||
|
||||
| 路径 | 用途 | 说明 |
|
||||
|:---|:---|:---|
|
||||
| `.ai-specs\doc-dict\book_author_status.md` | 定义作者状态的标准值域 | 涉及作者状态的存储、校验、展示和接口出入参时必读 |
|
||||
| `.ai-specs\doc-dict\common_enabled_status.md` | 定义通用启用/禁用状态的标准值域 | 涉及业务对象启用禁用状态的存储、校验、展示和接口出入参时必读 |
|
||||
| `.ai-specs\doc-dict\book_comment_status.md` | 定义书籍评论状态的标准值域 | 涉及评论状态存储、评论隐藏和评论出入参展示时必读 |
|
||||
| `.ai-specs\doc-dict\book_completion_status.md` | 定义书籍完结状态的标准值域 | 涉及书籍完结状态的存储、校验、展示和接口出入参时必读 |
|
||||
| `.ai-specs\doc-dict\book_era_tag.md` | 定义书籍时代标签的标准值域 | 涉及时代标签存储、筛选聚合和接口出入参时必读 |
|
||||
|
||||
Reference in New Issue
Block a user