复现已有算法
This commit is contained in:
@@ -0,0 +1,91 @@
|
||||
---
|
||||
name: edge-design-reviewer
|
||||
description: edge_collector 详细设计与方案评审规范。用于评审协议适配、云平台功能、边缘 agent、AI 分析、本地模型、前端页面、部署机制等设计文档,检查结构完整性、边界、接口、配置、数据流、前端可实现性、部署影响、测试和回滚。
|
||||
---
|
||||
|
||||
# edge_collector 设计评审
|
||||
|
||||
## 评审目标
|
||||
|
||||
确认设计文档足够指导实现、测试和部署,不留下关键歧义。
|
||||
|
||||
## 结论级别
|
||||
|
||||
- `[严重]`:会导致无法实现、运行风险或数据/配置损坏。
|
||||
- `[警告]`:可实现但存在质量、可维护性或验证缺口。
|
||||
- `[建议]`:改进项,不阻塞。
|
||||
|
||||
通过标准:无 `[严重]`,关键 `[警告]` 有明确处理计划。
|
||||
|
||||
## 评审维度
|
||||
|
||||
### 1. 文档结构
|
||||
|
||||
- 背景、目标、范围、不做什么是否明确。
|
||||
- 是否有现状分析和约束。
|
||||
- 是否有实施步骤和验证计划。
|
||||
- 是否写清假设和待确认项。
|
||||
|
||||
### 2. 云边职责
|
||||
|
||||
- 边缘侧、云平台、前端、独立 agent 职责是否清晰。
|
||||
- 是否把高风险或长耗时任务放到合适进程。
|
||||
- 新增常驻进程是否独立,不耦合 `edge` 主服务。
|
||||
|
||||
### 3. 接口与配置
|
||||
|
||||
- API 路径、方法、请求、响应、错误码是否完整。
|
||||
- JSON 字段是否符合当前后端约定。
|
||||
- 配置文件路径、默认值、动态生成规则是否明确。
|
||||
- 是否会覆盖运行态动态配置。
|
||||
|
||||
### 4. 数据流与状态流
|
||||
|
||||
- 采集、缓存、上传、云端入库、展示、AI 分析链路是否完整。
|
||||
- 状态机是否覆盖成功、失败、超时、重试、停止。
|
||||
- 离线、断网、重启、服务异常是否有处理。
|
||||
|
||||
### 5. 前端可实现性
|
||||
|
||||
- 页面布局、主要状态、按钮反馈、错误提示是否明确。
|
||||
- 用户可见文案是否隐藏内部技术细节。
|
||||
- 权限、空状态、loading、长内容滚动是否覆盖。
|
||||
- 复杂页面是否需要原型或图示。
|
||||
|
||||
### 6. 部署与运维
|
||||
|
||||
- 是否影响 `package.sh`、`deploy_cloud.sh`、`scripts/migrate_edge.sh`。
|
||||
- 是否需要 `install_all.sh`,是否明确执行条件。
|
||||
- 是否需要 systemd 服务、日志路径、重启策略。
|
||||
- 是否考虑 82/97/94/87 和云服务器差异。
|
||||
|
||||
### 7. 测试与回滚
|
||||
|
||||
- 是否有单元、构建、接口、前端、设备或远程验证。
|
||||
- 是否覆盖异常场景。
|
||||
- 是否有回滚或降级策略。
|
||||
- 是否能验证“不覆盖运行配置”。
|
||||
|
||||
## 输出格式
|
||||
|
||||
```markdown
|
||||
## 评审结论
|
||||
|
||||
通过 / 不通过 / 有条件通过
|
||||
|
||||
## 问题列表
|
||||
|
||||
| 级别 | 位置 | 问题 | 影响 | 建议 |
|
||||
|------|------|------|------|------|
|
||||
|
||||
## 待确认项
|
||||
|
||||
## 建议补充验证
|
||||
```
|
||||
|
||||
## 注意
|
||||
|
||||
- 评审先列问题,再写总结。
|
||||
- 文件和行号尽量具体。
|
||||
- 不把个人偏好当成缺陷。
|
||||
- 如果设计引用官方能力或第三方 SDK,拿不准时要联网查证。
|
||||
Reference in New Issue
Block a user