[优化] 文档更新

This commit is contained in:
ryan
2026-06-05 10:48:48 +08:00
parent 546856594e
commit 189916d1db
28 changed files with 821 additions and 990 deletions
+32
View File
@@ -0,0 +1,32 @@
# AI 接手计划模板
说明:本模板用于在 AI 代理上下文发生截断、压缩(Compaction)或将任务转移给另一个 AI 代理时使用,帮助新接手的 AI 快速恢复 100% 的工作状态。
---
## 1. 当前任务状态 (Current Status)
* **主线任务描述**:用一句话说清楚当前正在解决的核心问题。
* **开发分支/提交**:记录当前的工作目录、修改的未暂存文件、或 Git 临时分支名。
* **已完成内容 (Completed)**:
- [x] 功能 A 后端接口及单测
- [x] 前端面板表单组件
- **进行中内容 (In Progress)**:
- [/] 配置文件渲染与重写模块
- **待处理内容 (To Do)**:
- [ ] 边缘节点同步下载与校验落地
- [ ] 发布功能整体连通性验证
## 2. 核心文件与上下文 (Key Files & Context)
列出与当前开发高度相关的核心文件以及需要注意的特殊背景:
* `file:///path/to/core_file.go#L100-L150`:此处负责...,修改时需要注意...
* `file:///path/to/frontend_component.tsx`:用于展现...
## 3. 待决策与遗留问题 (Outstanding Decisions & Issues)
* [ ] **疑问/阻塞点**:是否需要支持某某场景?目前是如何兜底处理的?
* [ ] **异常与缺陷**:单测 `./controller/...` 运行时目前有 1 个 Fail,失败原因为...
## 4. 下一步行动指南 (Next Steps)
新接手 AI 进来后应当立即执行的前 3 步命令或编辑操作:
1. **第一步**:执行 `go test ./controller/...` 确认环境并复现 Fail 异常。
2. **第二步**:修改 `openflare_server/controller/xxx.go` 中的逻辑以修复该 Fail。
3. **第三步**:在管理端前端页面调试 xxx 表单的提交是否正常。
+47
View File
@@ -0,0 +1,47 @@
# 功能开发实现计划模板
说明:本模板用于指导新特性或重大模块开发前的技术规划,明确需求、范围与设计决策。
---
## 1. 目标与背景 (Goal & Context)
* **需求背景**:说明为什么要开发这个特性,解决什么业务痛点或安全隐患。
* **开发范围 (Scope)**:明确 V1 阶段的核心交付指标。哪些是本次必做的,哪些是留到后续迭代的(Out of Scope)。
## 2. 设计与决策决策 (Design & Decisions)
* **核心对象/数据模型**:
* 说明是否需要修改或新增数据库表(Gorm 结构体、Migration SQL,包括新增字段与关联)。
* **API 与鉴权设计**:
* 详细定义新增的 REST API 路由、请求载荷(Payload JSON)与响应格式。
* **数据流与架构图**:
* 使用 Mermaid 绘制数据或控制流的流向。
* **设计决策权衡**:
* 记录为何选用方案 A 而非方案 B。
## 3. 具体修改文件清单 (Proposed Changes)
按模块或组件列出需要修改的物理文件路径及修改点:
### 后端 Server
* #### [NEW] `openflare_server/model/entity.go`
* 职责:...
* #### [MODIFY] `openflare_server/service/feature.go`
* 职责:...
### 边缘 Agent 与 OpenResty
* #### [MODIFY] `openflare_agent/sync/sync.go`
* 职责:...
### 前端 Web
* #### [NEW] `openflare_server/web/features/feature-view.tsx`
* 职责:...
---
## 4. 验证计划 (Verification Plan)
### 自动化单元测试
* 运行的单测命令,如:`go test -v ./service/...`
### 数据面重载与生效验证
* 说明如何验证新配置在数据面落地。
* 提供验证测试的 `curl` 指令或手动操作路径。
+16
View File
@@ -0,0 +1,16 @@
# 开发计划与 AI 接手
本分区用于存放正在进行的开发计划(Plan)以及 AI 代理之间的工作接手计划(Handover)。这能帮助不同的 AI 代理快速掌握当前项目状态、历史上下文与后续开发步骤。
## 计划模板
在创建具体的开发计划或接手文档时,请使用以下标准模板进行初始化:
1. **[实现计划模板](./implementation-plan-template.md)**:用于新功能开发或重大重构前的技术方案规划。
2. **[AI 接手计划模板](./handover-plan-template.md)**:用于在上下文截断、压缩或更换 AI 代理时,记录当前任务状态、已完成内容与下一步执行计划。
## 使用建议
* **命名规范**:正在进行的开发计划建议命名为 `docs/plan/YYYYMMDD-[feature-name].md`,接手计划建议命名为 `docs/plan/handover-[task-name].md`。
* **物理隔离**:本目录下的计划文件只在开发周期内进行更新。当对应功能开发完毕并上线后,相应的计划文档应予以保留或归档,以供日后维护与新 AI 追溯历史决策。
* **禁止空文件**:请确保新创建的计划文档均基于对应的模板进行初始化填充。