This commit is contained in:
admin
2026-04-11 20:46:55 +08:00
parent e6c2d76238
commit e04405d0bc
70 changed files with 10438 additions and 332 deletions

View File

@@ -0,0 +1,114 @@
# 常见计划模式库
预定义的任务模板,可快速复用于常见场景。
---
## 使用方式
当识别到以下常见模式时,可直接引用对应模板。
---
## 模式 1CRUD 模块
**适用场景**:数据增删改查操作
**典型文件结构**
| 文件 | 职责 |
|------|------|
| `src/models/<entity>.ts` | 数据模型定义 |
| `src/repositories/<entity>Repository.ts` | 数据访问层 |
| `src/services/<entity>Service.ts` | 业务逻辑层 |
| `src/controllers/<entity>Controller.ts` | API 控制器 |
| `tests/<entity>.test.ts` | 测试文件 |
**典型任务顺序**
1. 定义数据模型
2. 实现 RepositoryCRUD 操作)
3. 实现 Service业务逻辑
4. 实现 ControllerAPI 端点)
5. 集成测试
---
## 模式 2认证模块
**适用场景**:用户认证授权
**典型文件结构**
| 文件 | 职责 |
|------|------|
| `src/auth/jwtHandler.ts` | JWT 令牌处理 |
| `src/auth/middleware.ts` | 认证中间件 |
| `src/auth/refreshHandler.ts` | 令牌刷新 |
| `src/services/userService.ts` | 用户服务 |
| `tests/auth.test.ts` | 认证测试 |
**典型任务顺序**
1. 实现 JWT 生成和验证
2. 实现认证中间件
3. 实现登录/登出逻辑
4. 实现令牌刷新机制
5. 权限验证
---
## 模式 3API 集成
**适用场景**:第三方服务集成
**典型文件结构**
| 文件 | 职责 |
|------|------|
| `src/clients/<service>Client.ts` | API 客户端 |
| `src/adapters/<service>Adapter.ts` | 数据适配器 |
| `src/services/<service>Service.ts` | 业务封装 |
| `src/mocks/<service>Mock.ts` | 模拟实现 |
| `tests/<service>.test.ts` | 集成测试 |
**典型任务顺序**
1. 定义 API 客户端接口
2. 实现请求/响应处理
3. 实现数据适配层
4. 实现错误处理和重试
5. 创建模拟实现用于测试
---
## 模式 4中间件/插件
**适用场景**:请求处理管道、插件系统
**典型文件结构**
| 文件 | 职责 |
|------|------|
| `src/middleware/<name>.ts` | 中间件实现 |
| `src/types/middleware.ts` | 类型定义 |
| `tests/middleware/<name>.test.ts` | 测试文件 |
**典型任务顺序**
1. 定义中间件接口
2. 实现核心逻辑
3. 实现配置选项
4. 错误处理
5. 集成测试
---
## 模式引用方式
在计划中引用模式:
```markdown
### 任务组:用户管理 CRUD
> 引用模式CRUD 模块
> 实体User
[基于模式模板编写具体任务...]
```

View File

@@ -0,0 +1,107 @@
# 实施计划模板
本文档提供实施计划的标准结构。
---
## 文档路径
```
design/plans/YYYY-MM-DD-<feature>.md
```
---
## 单一子系统计划模板
```markdown
# [功能名称] 实施计划
**目标**[一句话描述此功能构建什么]
**架构**[2-3 句关于方法]
**技术栈**[关键技术/库]
---
## 文件结构
### 新建文件
- `path/to/new/file.ts` - 职责描述
### 修改文件
- `path/to/existing/file.ts` - 修改内容描述
### 测试文件
- `tests/path/to/test.ts` - 测试职责
---
## 任务列表
### 任务 1[任务名称]
**文件**
- 创建:`path/to/file.ts`
- 测试:`tests/path/to/test.ts`
- [ ] **步骤 1**:编写失败测试
- [ ] **步骤 2**:运行测试验证失败
- [ ] **步骤 3**:编写最小实现
- [ ] **步骤 4**:运行测试验证通过
### 任务 2[任务名称]
[继续按相同模式...]
```
---
## 多子系统纲领文件模板
```markdown
# [项目名称] 实施计划纲领
## 子系统划分
| 子系统 | 范围 | 依赖 | 状态 |
|--------|------|------|------|
| 子系统A | [范围] | 无 | 待编写 |
| 子系统B | [范围] | A | 待编写 |
## 执行顺序
1. 子系统A无依赖
2. 子系统B依赖A
## 共享组件
| 组件 | 使用子系统 | 定义位置 |
|------|------------|----------|
| [组件名] | A, B | 子系统A计划中 |
```
---
## 分块指南
| 指标 | 标准 | 原因 |
|------|------|------|
| 行数 | 300-500 行 | 适配上下文窗口 |
| 任务数 | 5-10 个 | 保持逻辑完整性 |
**分块边界**
- 按功能模块分块
- 按实施阶段分块(基础设施、核心功能、集成测试)
- 按子系统分块
---
## 任务要求
- 精确文件路径,无模糊引用
- 计划中包含完整代码,非占位符
- 精确命令及预期输出
- 测试优先方法TDD
- 每个步骤 2-5 分钟可完成