docs: 新增运维和使用指南文档

新增文档:
- guides/ADMIN_GUIDE.md — 管理员操作手册(用户/角色/设备/日志管理)
- guides/USER_GUIDE.md — 普通用户操作手册(注册/登录/TOTP/设备管理)
- guides/CONFIG_REFERENCE.md — 配置文件参考手册(含全部配置项说明)
- guides/MONITORING.md — 健康检查、Prometheus 指标和告警规则

同步更新:
- docs/README.md 文档索引,加入新增文档链接
This commit is contained in:
2026-05-10 13:22:51 +08:00
parent bb7588b7c0
commit f050c60a09
5 changed files with 1181 additions and 0 deletions

View File

@@ -24,6 +24,20 @@
| `API.md` | 当前 API 合同。 |
| `PROJECT_REVIEW_REPORT.md` | 当前 review 报告。 |
## 运维与使用指南guides/
| 路径 | 说明 |
|------|------|
| `guides/ADMIN_GUIDE.md` | 管理员操作手册(用户/角色/设备/日志管理)。 |
| `guides/USER_GUIDE.md` | 普通用户操作手册(注册/登录/TOTP/设备管理)。 |
| `guides/CONFIG_REFERENCE.md` | 配置文件参考手册(含全部配置项说明)。 |
| `guides/MONITORING.md` | 健康检查、Prometheus 指标和告警规则。 |
| `guides/ALERTING_ONCALL_RUNBOOK.md` | 告警响应和值班 Runbook。 |
| `guides/ROLLBACK_RUNBOOK.md` | 回滚操作 Runbook。 |
| `guides/TESTING.md` | 测试执行指南。 |
| `guides/GO_TROUBLESHOOTING.md` | Go 问题排查指南。 |
| `DEPLOYMENT.md` | 部署和运维指南(容器化部署、集群方案)。 |
## 归档说明
- 已被新状态、新规则或新结论替代的历史文档,应移动到 `docs/archive/`