[优化] 文档更新

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
+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` 指令或手动操作路径。