cloud
57 lines
2.0 KiB
Markdown
57 lines
2.0 KiB
Markdown
---
|
|
name: edge-user-manual-writer
|
|
description: edge_collector 用户手册与交付说明编写规范。用于为边缘侧前端、云平台、协议配置、AI 分析、WiFi、端口转发、内网穿透、OTA、离线缓存等用户可见功能编写操作说明、培训材料、交付文档和常见问题，避免暴露内部技术细节。
|
|
---
|
|
|
|
# edge_collector 用户手册编写
|
|
|
|
## 读者
|
|
|
|
- 现场实施人员。
|
|
- 运维人员。
|
|
- 管理后台用户。
|
|
- 客户侧使用人员。
|
|
|
|
## 文档落点
|
|
|
|
- 用户手册：`docs/` 或对应专题目录。
|
|
- 协议用户说明：优先与协议文档分开，用户可见介绍不能写内部实现细节。
|
|
- 鲁班猫设备操作：`docs/鲁班猫*/`。
|
|
|
|
## 推荐结构
|
|
|
|
```text
|
|
功能用途
|
|
适用场景
|
|
使用前准备
|
|
操作步骤
|
|
参数说明
|
|
状态说明
|
|
常见问题
|
|
注意事项
|
|
```
|
|
|
|
## 写作规则
|
|
|
|
- 面向用户目标写，不按代码模块写。
|
|
- 只写用户能看到、能操作、能验证的内容。
|
|
- 隐藏内部模型名、AI Provider 名称、helper、进程、库路径等技术细节，除非读者是运维人员且文档明确为运维手册。
|
|
- 参数说明要写“影响和建议值”，不要只复述字段名。
|
|
- 错误说明要写用户下一步可以怎么处理。
|
|
|
|
## 当前项目常见功能口径
|
|
|
|
- AI 分析：说明分析深度、提示词、数据不连续的业务原因，不显示内部 AI 配置。
|
|
- WiFi 管理：说明扫描、刷新、加入隐藏网络、已保存网络连接、自动连接。
|
|
- 内网穿透：说明映射启停、保存配置、云端配置失败提示。
|
|
- 端口转发：说明规则启停、监听地址、目标地址、冲突端口。
|
|
- 离线缓存：说明最大缓存、保留天数、重传批次、重传速率的影响。
|
|
|
|
## 检查清单
|
|
|
|
- 功能名称和界面文案一致。
|
|
- 操作步骤能被现场用户照着完成。
|
|
- 参数默认值和当前代码/配置一致。
|
|
- 没有泄露内部接口、密钥、模型、库路径。
|
|
- 有失败场景和恢复建议。
|