106 lines
3.1 KiB
Markdown
106 lines
3.1 KiB
Markdown
|
# {module}-{feature} - Progress (Example)
|
|||
|
|
|
|||
|
|
> 示例文件：用于演示 `docs/session-handoff-protocol.md` 的进度文档结构。
|
|||
|
|
> 复制此文件并重命名为：`docs/progress/{module}-{feature}-progress.md`
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 📋 Context
|
|||
|
|
|
|||
|
|
- module: `ruoyi-forum`
|
|||
|
|
- feature: `REG` (example)
|
|||
|
|
- status: 🔄 进行中
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🔗 Spec References (SSOT)
|
|||
|
|
|
|||
|
|
- agents: `agents.md`
|
|||
|
|
- contracting: `spec/contracting.md`
|
|||
|
|
- requirements: `spec/ruoyi-forum/requirements.md`
|
|||
|
|
- openapi_provider: `spec/ruoyi-forum/openapi.provider.yaml`
|
|||
|
|
- openapi_deps: `spec/ruoyi-forum/openapi.deps.yaml`
|
|||
|
|
- design: `spec/ruoyi-forum/design.md`
|
|||
|
|
- tasks: `spec/ruoyi-forum/tasks.md`
|
|||
|
|
|
|||
|
|
> 注意：以上路径必须与实际模块目录一致；如果文件不存在，先创建/补齐 spec，再编码。
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 📊 Overall Progress (Phases)
|
|||
|
|
|
|||
|
|
- [ ] Phase 1: Spec 初始化与对齐 (60%) 🔄 [tasks.md: T-INIT]
|
|||
|
|
- [ ] Phase 2: Provider 实现与契约校验 (0%) ⏳ [tasks.md: T-PROVIDER]
|
|||
|
|
- [ ] Phase 3: Consumer 并行开发（Mock/SDK） (0%) ⏳ [tasks.md: T-CONSUMER]
|
|||
|
|
- [ ] Phase 4: 集成测试 / 回归 / 合并门禁 (0%) ⏳ [tasks.md: T-INTEGRATION]
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🔄 Current Phase
|
|||
|
|
|
|||
|
|
### Goal
|
|||
|
|
在 `spec/ruoyi-forum/` 下完成 requirements + openapi(provider/deps) 的最小可并行版本。
|
|||
|
|
|
|||
|
|
### Sub Tasks
|
|||
|
|
- [x] 梳理模块边界与依赖清单 ✅ [tasks.md: T-INIT-01]
|
|||
|
|
- [ ] 生成 `requirements.md` 草案 🔄 [tasks.md: T-INIT-02]
|
|||
|
|
- [ ] 生成 `openapi.provider.yaml` 与 `openapi.deps.yaml` (L0) ⏳ [tasks.md: T-INIT-03]
|
|||
|
|
|
|||
|
|
### Next Action (Must be Specific)
|
|||
|
|
|
|||
|
|
**Immediate**: 生成 `spec/ruoyi-forum/requirements.md` 的验收标准（AC）与 Traceability 映射表。
|
|||
|
|
|
|||
|
|
**Details**:
|
|||
|
|
1. file: `spec/ruoyi-forum/requirements.md`
|
|||
|
|
2. action: 补齐至少 3 条 AC（EARS），并在 Traceability 表中映射到计划中的 endpoint。
|
|||
|
|
3. reference:
|
|||
|
|
- `docs/spec-product-zh.md`（requirements 模板与 traceability 要求）
|
|||
|
|
- `agents.md`（必须先读 spec 再编码、AC 追踪硬规则）
|
|||
|
|
4. constraints:
|
|||
|
|
- 不得在未更新 requirements 的情况下更改业务口径
|
|||
|
|
- AC ID 必须稳定可追溯（示例：`AC-REG-01`）
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🏗️ Technical Context
|
|||
|
|
|
|||
|
|
### Module Structure (Only What Matters)
|
|||
|
|
|
|||
|
|
- `spec/ruoyi-forum/`
|
|||
|
|
- `requirements.md`
|
|||
|
|
- `openapi.provider.yaml`
|
|||
|
|
- `openapi.deps.yaml`
|
|||
|
|
- `design.md`
|
|||
|
|
- `tasks.md`
|
|||
|
|
|
|||
|
|
### Key Decisions (Why / Impact)
|
|||
|
|
|
|||
|
|
- decision: OpenAPI 拆分 provider/deps
|
|||
|
|
reason: 支持 consumer-first 并行开发；调用方可基于 deps 生成 mock/SDK
|
|||
|
|
impact: provider 实现需在合并前提升 provider 契约到 L2 并通过契约校验
|
|||
|
|
|
|||
|
|
### Code Snippets (Optional but Recommended)
|
|||
|
|
|
|||
|
|
```text
|
|||
|
|
// 示例：在 controller / @Operation / 测试用例 / commit 中包含 [AC-...] 以便追踪
|
|||
|
|
// [AC-REG-01]
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🧾 Session History
|
|||
|
|
|
|||
|
|
### Session #1 (YYYY-MM-DD)
|
|||
|
|
- completed:
|
|||
|
|
- 初始化 Phase 划分与任务清单
|
|||
|
|
- changes:
|
|||
|
|
- 新增 docs/progress/example-progress.md
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 🚀 Startup Guide
|
|||
|
|
|
|||
|
|
1. 读取本进度文档，定位当前 Phase 与 Next Action。
|
|||
|
|
2. 打开并阅读 Spec References 指向的模块规范（requirements/openapi/tasks）。
|
|||
|
|
3. 直接执行 Next Action；遇到缺口先更新 spec 再编码。
|