zk
32 lines
1.4 KiB
Markdown
32 lines
1.4 KiB
Markdown
---
|
|
inclusion: always
|
|
---
|
|
|
|
# 项目规范执行指引
|
|
|
|
## 方案讨论前
|
|
|
|
必读 `#[[file:.kiro/steering/项目结构说明.md]]`，全面了解：
|
|
- 项目分层结构：`config` → `core` → `ai` → `models` → `services` → `api`
|
|
- 所有 ORM 模型及其关联
|
|
- 鉴权体系设计（JWT + Redis + 功能权限）
|
|
- 现有的公共能力（中间件、日志、异常处理、AI 模型枚举），避免重复造轮子
|
|
- 与 Java 后端（back-end）的关系：共享数据库、Redis、JWT Secret
|
|
|
|
方案讨论时：
|
|
- 优先给出简洁的方案思路（涉及哪些模块、新增内容放在哪、核心流程概要），不要一开始就铺开所有细节
|
|
- 用户明确要求时，再给出详细的方案流程（表结构、接口清单、完整逻辑步骤等）
|
|
- 做好解耦，说明与现有模块的关系
|
|
|
|
## 开发方案输出前 / 写代码前
|
|
|
|
必读 `#[[file:.kiro/steering/代码开发风格文档.md]]`，严格遵守：
|
|
- 命名约定、类型注解规范
|
|
- 分包规则（api/services/models/schemas 按功能模块组织）
|
|
- Service 类注释规范（主要功能、依赖服务、使用的表、方法逻辑流程）
|
|
- 接口规范、异常处理、Redis 使用、数据库设计风格
|
|
|
|
## 写完代码后
|
|
|
|
涉及新增文件、新增模块或目录结构变更时，必须同步更新 `#[[file:.kiro/steering/项目结构说明.md]]`，保持文档与实际代码一致。
|