docs: 迁移 spring-ai 通用文档到 rui-docs
从 docs-local 迁移以下文档: - backend/guides/: AI开发环境配置、Nacos配置、GitNexus指南、OpenCode工作流等 - backend/templates/: Superpowers设计模板、计划模板、审查清单 - backend/config-templates/: 应用配置模板、Nacos配置 - backend/design/: 数据库表结构规划 - backend/specs/: 项目文档治理、MQ统一推送设计 - backend/: 代码分析报告、Feign分析报告、文档治理报告 - frontend/design/: Admin-UI分模块打包设计
This commit is contained in:
@@ -0,0 +1,54 @@
|
||||
# <模块/功能名称> 设计文档
|
||||
|
||||
> **设计日期**: YYYY-MM-DD
|
||||
> **版本**: v1.0
|
||||
> **状态**: 设计中/已批准
|
||||
> **目标**: <一句话描述目标>
|
||||
|
||||
---
|
||||
|
||||
## 一、背景与目标
|
||||
|
||||
### 1.1 现状分析
|
||||
<描述当前现状、存在的问题>
|
||||
|
||||
### 1.2 目标定义
|
||||
<明确本次设计的目标,建议 3-5 条>
|
||||
|
||||
---
|
||||
|
||||
## 二、详细设计
|
||||
|
||||
### 2.1 整体架构
|
||||
<架构图、流程图>
|
||||
|
||||
### 2.2 核心组件
|
||||
<各组件的职责、接口>
|
||||
|
||||
### 2.3 数据流
|
||||
<数据如何流转>
|
||||
|
||||
### 2.4 接口设计
|
||||
<API 定义>
|
||||
|
||||
### 2.5 数据库设计
|
||||
<表结构、索引>
|
||||
|
||||
### 2.6 错误处理
|
||||
<异常场景、错误码>
|
||||
|
||||
---
|
||||
|
||||
## 三、验收标准
|
||||
|
||||
- [ ] <可验证的验收条件 1>
|
||||
- [ ] <可验证的验收条件 2>
|
||||
- [ ] <可验证的验收条件 3>
|
||||
|
||||
---
|
||||
|
||||
## 四、风险与依赖
|
||||
|
||||
| 风险 | 影响 | 缓解措施 |
|
||||
|------|------|---------|
|
||||
| <风险 1> | 高/中/低 | <措施> |
|
||||
@@ -0,0 +1,32 @@
|
||||
# <模块/功能名称> 实施计划
|
||||
|
||||
> **计划日期**: YYYY-MM-DD
|
||||
> **版本**: v1.0
|
||||
> **状态**: 待执行/执行中/已完成
|
||||
> **关联设计**: <链接到设计文档>
|
||||
|
||||
---
|
||||
|
||||
## 一、任务清单
|
||||
|
||||
### Phase 1: <阶段名称>
|
||||
|
||||
| 序号 | 任务 | 负责人 | 预估工时 | 状态 | 验证方式 |
|
||||
|------|------|--------|---------|------|---------|
|
||||
| 1.1 | <具体任务> | <负责人> | <工时> | ⬜ | <如何验证> |
|
||||
|
||||
---
|
||||
|
||||
## 二、进度跟踪
|
||||
|
||||
| 日期 | 完成任务 | 遇到的问题 | 解决方案 |
|
||||
|------|---------|-----------|---------|
|
||||
| YYYY-MM-DD | <任务> | <问题> | <方案> |
|
||||
|
||||
---
|
||||
|
||||
## 三、完成总结
|
||||
|
||||
- **实际工时**: <X 小时>
|
||||
- **偏差分析**: <与预估的差异及原因>
|
||||
- **经验教训**: <可复用的经验>
|
||||
@@ -0,0 +1,25 @@
|
||||
# 代码审查清单
|
||||
|
||||
## 基础规范
|
||||
- [ ] 使用 Lombok,无手写 getter/setter
|
||||
- [ ] Service 使用构造器注入
|
||||
- [ ] Entity 继承 BaseEntity
|
||||
- [ ] 类名不加 Rui 前缀(除非冲突)
|
||||
|
||||
## Mapper 规范
|
||||
- [ ] SQL 使用 `#prefix#` 占位符
|
||||
- [ ] 无硬编码表前缀
|
||||
|
||||
## Controller 规范
|
||||
- [ ] 标准 CRUD 继承 BaseController
|
||||
- [ ] URL 路径符合规范
|
||||
- [ ] 使用正确注解(@Inner、@AuthIgnore 等)
|
||||
|
||||
## 异常与日志
|
||||
- [ ] 使用 BizException 而非 RuntimeException
|
||||
- [ ] 返回 Result.ok()/Result.fail()
|
||||
- [ ] 日志无敏感信息
|
||||
|
||||
## 测试
|
||||
- [ ] 核心逻辑有单元测试
|
||||
- [ ] 测试命名符合规范(should_ 开头)
|
||||
Reference in New Issue
Block a user