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

同步更新:
- docs/README.md 文档索引,加入新增文档链接
2026-05-10 13:22:51 +08:00

2.1 KiB
Raw Blame History

文档索引

docs/ 目录只保留当前仍然有效、且应作为实现与协作依据的文档入口。

当前优先阅读

  1. README.md
  2. status/REAL_PROJECT_STATUS.md
  3. team/QUALITY_STANDARD.md
  4. team/PRODUCTION_CHECKLIST.md
  5. team/PROJECT_EXPERIENCE_SUMMARY.md
  6. ../AGENTS.md

当前有效文档

路径 说明
status/REAL_PROJECT_STATUS.md 当前真实项目状态和对外可诚实表述的边界。
team/QUALITY_STANDARD.md 当前项目工程规则。
team/PRODUCTION_CHECKLIST.md 生产级发布前后核查清单。
team/PROJECT_EXPERIENCE_SUMMARY.md 本轮项目沉淀出的真实经验。
team/TECHNICAL_GUIDE.md 当前技术入口索引。
plans/ADMIN_FRONTEND_EXECUTION_PLAN.md 当前前端执行方案。
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/
  • docs/archive/ 只保留历史追溯价值,不再作为当前实现依据。