---
name: edge-design-doc-writer
description: edge_collector 详细设计与方案文档编写规范。用于新增功能、协议适配、AI 功能、边缘 agent、云端功能、前端页面或部署机制前，输出适合本仓库 docs 结构的设计文档、接口草案、数据流、验证计划和实施拆分。
---

# edge_collector 设计文档编写

## 适用文档

- 功能方案设计
- 详细设计
- 协议适配方案
- 本地模型部署方案
- 云边协同方案
- 边缘 agent 方案
- 前端页面方案

## 文档落点

- 通用方案：`docs/`
- 本地模型：`docs/本地模型/`
- 鲁班猫专题：`docs/鲁班猫*/`
- 协议实现：`collector/docs/protocols/`
- 采集架构：`collector/docs/`

## 推荐内容

```text
背景与目标
现状与问题
设计原则
总体架构
目录与配置
接口/API
数据流/状态流
权限与安全
实施步骤
验证计划
风险与对策
```

## 本项目必须考虑

- 边缘侧和云端职责是否清晰。
- 是否影响 `collector` 采集稳定性。
- 是否需要新增独立 agent 或 systemd 服务。
- 是否会覆盖运行时动态配置。
- 是否需要 82/97/94/87 主机验证。
- 是否需要 `package.sh` 或 `scripts/migrate_edge.sh` 改动。
- 是否需要协议模板、用户可见介绍和技术文档分开。

## 图示

流程或状态变化可用 ASCII 图；复杂架构图使用 `edge-svg-diagram`。

## 方案验证

文档结尾必须写：

- 单元测试或脚本验证。
- 构建验证。
- 远程部署验证（如需要）。
- 回滚或降级策略。