mirror of
https://github.com/Rain-kl/OpenFlare.git
synced 2026-09-29 22:06:38 +08:00
[优化] 文档更新
This commit is contained in:
+1
-21
@@ -314,28 +314,8 @@ Agent 接口当前覆盖:
|
||||
* Agent API 固定放在 `/api/agent/*`
|
||||
* Agent 鉴权使用 `X-Agent-Token`
|
||||
|
||||
---
|
||||
|
||||
## 10. 第三版设计准备要求
|
||||
|
||||
第三版开始编码前,至少先在本文档补齐以下内容:
|
||||
|
||||
1. **目标问题**:第三版要解决什么实际痛点
|
||||
2. **范围边界**:明确要做与不做
|
||||
3. **对象变化**:是否新增表、字段、状态流转
|
||||
4. **链路影响**:是否影响发布链路、Agent 同步链路、部署方式
|
||||
5. **兼容策略**:是否影响现有节点、现有版本、现有配置
|
||||
6. **验收标准**:如何判断第三版完成
|
||||
|
||||
如果第三版包含以下变化,还必须同步更新其他文档:
|
||||
|
||||
* 技术约束变化:更新 `docs/development-guidelines.md`
|
||||
* 开发阶段与顺序变化:更新 `docs/development-plan.md`
|
||||
* 部署方式变化:更新 `docs/deployment.md`
|
||||
|
||||
---
|
||||
|
||||
## 11. 文档策略
|
||||
## 10. 文档策略
|
||||
|
||||
第一版、第二版的详细实施过程不再在本文档中长期保留。
|
||||
|
||||
|
||||
+1
-115
@@ -37,118 +37,4 @@
|
||||
归档原则:
|
||||
|
||||
* 已完成阶段的实现细节以代码和 Git 历史为准
|
||||
* 后续计划文档只维护当前阶段与下一阶段
|
||||
|
||||
---
|
||||
|
||||
## 3. 第三版启动前置条件
|
||||
|
||||
第三版正式立项前,必须先明确以下内容:
|
||||
|
||||
1. 目标问题与业务价值
|
||||
2. 范围边界与明确不做项
|
||||
3. 涉及的核心对象与 API 变化
|
||||
4. 对发布链路、Agent 链路、部署方式的影响
|
||||
5. 验收标准与回归范围
|
||||
|
||||
未满足以上条件时,不进入第三版编码阶段。
|
||||
|
||||
---
|
||||
|
||||
## 4. 第三版建议执行骨架
|
||||
|
||||
在第三版范围明确后,按以下顺序推进:
|
||||
|
||||
### Phase A:设计冻结
|
||||
|
||||
交付:
|
||||
|
||||
* 更新后的 `docs/design.md`
|
||||
* 更新后的 `docs/development-guidelines.md`
|
||||
* 明确的验收标准
|
||||
|
||||
完成标准:
|
||||
|
||||
* 第三版目标、范围、对象变化、兼容策略写清楚
|
||||
|
||||
### Phase B:后端主链路
|
||||
|
||||
交付:
|
||||
|
||||
* 数据模型变更
|
||||
* API 变更
|
||||
* 服务层逻辑与测试
|
||||
|
||||
完成标准:
|
||||
|
||||
* Server 侧主链路可独立验证
|
||||
|
||||
### Phase C:Agent / 前端配套
|
||||
|
||||
交付:
|
||||
|
||||
* Agent 适配改动
|
||||
* 前端页面或交互改动
|
||||
* 必要的回归测试
|
||||
|
||||
完成标准:
|
||||
|
||||
* 控制面、Agent、页面链路联通
|
||||
|
||||
### Phase D:联调与收尾
|
||||
|
||||
交付:
|
||||
|
||||
* 联调记录
|
||||
* 部署文档更新
|
||||
* 遗留问题清单
|
||||
|
||||
完成标准:
|
||||
|
||||
* 新能力可按部署文档落地验证
|
||||
|
||||
---
|
||||
|
||||
## 5. 第三版期间禁止事项
|
||||
|
||||
在第三版需求未明确前,不提前开始以下工作:
|
||||
|
||||
* 引入 Redis、MQ、对象存储等新基础设施
|
||||
* 实现节点分组与差异化发布
|
||||
* 实现灰度百分比发布
|
||||
* 引入多租户模型
|
||||
* 对现有前端进行无业务价值的大重构
|
||||
|
||||
如果第三版确认需要以上能力,先改文档,再调整计划。
|
||||
|
||||
---
|
||||
|
||||
## 6. 第三版验收门槛模板
|
||||
|
||||
第三版正式验收时,至少检查:
|
||||
|
||||
* 设计文档与实现一致
|
||||
* 新增 API 与数据模型有测试覆盖
|
||||
* 发布链路未被破坏
|
||||
* Agent 同步与回滚链路未被破坏
|
||||
* 现有节点接入方式兼容或有明确迁移方案
|
||||
* 部署文档已同步更新
|
||||
|
||||
---
|
||||
|
||||
## 7. 变更控制
|
||||
|
||||
第三版开发中,出现以下情况必须先改文档再继续:
|
||||
|
||||
* 目标问题变化
|
||||
* 核心数据模型变化
|
||||
* 部署方式变化
|
||||
* 需要引入新的中间件或基础设施
|
||||
* 需要突破当前系统边界
|
||||
|
||||
同步更新清单:
|
||||
|
||||
* `docs/design.md`
|
||||
* `docs/development-guidelines.md`
|
||||
* `docs/development-plan.md`
|
||||
* `docs/deployment.md`
|
||||
* 后续计划文档只维护当前阶段与下一阶段
|
||||
Reference in New Issue
Block a user