初始化 pay-bridge 项目:PRD、需求文档和项目框架
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
79
docs/requirements/templates/module-template.md
Normal file
79
docs/requirements/templates/module-template.md
Normal file
@@ -0,0 +1,79 @@
|
||||
# 模块名称
|
||||
|
||||
## 概述
|
||||
|
||||
简要描述模块的核心职责和业务范围。
|
||||
|
||||
---
|
||||
|
||||
## 核心功能
|
||||
|
||||
> 按需求状态标记:已完成 | 开发中 | 规划中
|
||||
|
||||
| 功能 | 需求编号 | 状态 | 说明 |
|
||||
|------|----------|------|------|
|
||||
| 功能1 | REQ-XXX | 已完成 | 简要说明 |
|
||||
| 功能2 | REQ-XXX | 开发中 | 简要说明 |
|
||||
|
||||
---
|
||||
|
||||
## 业务规则
|
||||
|
||||
| 规则 | 说明 |
|
||||
|------|------|
|
||||
| 规则1 | 详细说明 |
|
||||
| 规则2 | 详细说明 |
|
||||
|
||||
---
|
||||
|
||||
## 数据模型
|
||||
|
||||
### 核心表
|
||||
|
||||
| 表名 | 说明 |
|
||||
|------|------|
|
||||
| `table_name` | 表用途说明 |
|
||||
|
||||
### 表关系
|
||||
|
||||
```
|
||||
表A --1:N-- 表B --N:M-- 表C
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 关键文件
|
||||
|
||||
| 层级 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| Model | `internal/xxx/model/` | 数据模型 |
|
||||
| Store | `internal/xxx/store/` | 数据访问 |
|
||||
| Biz | `internal/xxx/biz/` | 业务逻辑 |
|
||||
| Ctrl | `internal/xxx/controller/` | 接口控制器 |
|
||||
|
||||
---
|
||||
|
||||
## API 概览
|
||||
|
||||
| 方法 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| GET | `/api/v1/xxx` | 查询列表 |
|
||||
| POST | `/api/v1/xxx` | 创建 |
|
||||
| PUT | `/api/v1/xxx/:id` | 更新 |
|
||||
| DELETE | `/api/v1/xxx/:id` | 删除 |
|
||||
|
||||
---
|
||||
|
||||
## 相关需求
|
||||
|
||||
| 编号 | 标题 | 状态 | 更新时间 |
|
||||
|------|------|------|----------|
|
||||
| REQ-XXX | 需求标题 | 已完成 | YYYY-MM-DD |
|
||||
|
||||
---
|
||||
|
||||
## 变更记录
|
||||
|
||||
| 日期 | 变更内容 |
|
||||
|------|----------|
|
||||
| YYYY-MM-DD | 初始版本 |
|
||||
Reference in New Issue
Block a user