Files
wecom_it_smart_desk/docs/01-项目总览/00-索引-20260704.md
T
Simon e4e2de47bb docs: test reports + knowledge iteration design + PRDs
提交 OTP/RBAC/Tier0/Tier1/P0+P2 测试报告、方案A E2E 验证、知识库迭代设计(PRD/mermaid/html 原型)、项目状态看板更新; 根配置 docker-compose.yml/mkdocs.yml。
2026-07-09 11:50:19 +08:00

6.4 KiB
Raw Blame History

文档索引

版本: v2.0 | 日期: 2026-07-04 | 维护人: 助理 说明: 本索引提供 docs/ 目录下所有文档的快速导航


📚 文档目录结构

docs/
├── 01-项目总览/              ← 核心文档(必读)
├── 02-产品需求/              ← PRD、功能需求
├── 03-技术架构/              ← 架构设计、ADR、图表
├── 04-原型设计/              ← UI/UX原型
├── 05-用户手册/              ← 用户指南
├── 06-测试质量/              ← 测试文档
├── 07-代码评审/              ← Code Review
├── 08-安全审计/              ← 安全、集成分析
├── 09-部署运维/              ← 部署、运维、故障排查
├── 10-项目管理/              ← SOP、项目管理
└── 11-历史归档/              ← 历史归档

📋 核心文档(必读)

文档 路径 说明
项目总览与部署手册 01-项目总览/01-项目总览与部署手册-20260704.md 项目背景、架构、三阶段演进
智能IT服务系统运维手册 01-项目总览/01-智能IT服务系统运维手册-20260704.md 部署、运维、故障处理
项目知识库 01-项目总览/01-项目知识库-20260704.md 全量知识库汇总
资源申请清单 01-项目总览/01-资源申请清单-20260704.md IT 资源申请记录

📂 各目录文档清单

01-项目总览/

文档 说明
00-索引-20260704.md 本索引文档
01-项目总览与部署手册-20260704.md v2.2,项目完整概览
01-智能IT服务系统运维手册-20260704.md v1.0,统一运维手册
01-资源申请清单-20260704.md IT 资源申请记录
01-项目知识库-20260704.md 项目全量知识库
01-IT智能服务台_项目汇报-20260704.html 项目汇报演示
02-项目迁移文档-20260606.md 项目迁移文档
03-项目全面评估报告-20260625.md 项目全面评估报告

02-产品需求/

文档 说明
02-产品需求文档PRD-v1.2-20260704.md 主 PRD 文档(v1.22026-07-04更新)
product-产品/v0.7.2-backlog-candidate-2026-06-24.md 需求候选池

03-技术架构/

目录/文档 说明
00-系统架构设计文档-v1.3.md 系统架构设计(v1.3
01-ADRs-架构决策/ 4
02-技术方案/ 5
03-技术分析/ 3
04-数据库设计/ 1
05-架构图/ 9

04-原型设计/

子目录 文档数 说明
prototypes-原型图/ 12 活跃原型图
prototypes-原型图/archive/ 17 历史版本

05-用户手册/

待添加用户手册

06-测试质量/

文档 说明
09-部署运维/00-标准故障排查手册.md(§5 验证标准) 标准故障排查 + 端到端验证
testing-测试/E2E-CHECKLIST-v0.7.0.md E2E 验收清单
testing-测试/TESTING_CALL_AGENT.md 呼叫坐席测试
testing-测试/QA_COMPREHENSIVE_REPORT.md QA 综合报告

07-代码评审/

文档 说明
评审报告-代码评审/workbuddy-2026-06-14-P0安全.md P0 安全评审
评审报告-代码评审/workbuddy-2026-06-14-消息优化.md 消息优化评审
评审报告-代码评审/workbuddy-2026-06-14-消息优化-P1二次评审.md 消息优化二次评审
评审报告-代码评审/workbuddy-2026-06-14-Gitea重建.md Gitea 重建评审
评审报告-代码评审/workbuddy-2026-06-14-预检验证.md 预检验证评审
评审报告-代码评审/workbuddy-2026-06-15-T组A组.md T组A组评审
评审报告-代码评审/REVIEW_B_T10-消息可靠性增强.md B-T10 消息可靠性评审

08-安全审计/

子目录 文档数 说明
审计报告-安全审计/ 3 安全审计报告
集成分析-外部系统/ 3 外部系统集成分析

09-部署运维/

文档 说明
deploy/03-RELEASE-NOTES-v0.7.1-20260623.md v0.7.1 发布说明
00-标准故障排查手册.md 标准故障排查手册(含历史修复案例)
deploy/05-版本更新说明-v1.1.0-20260614.md 版本更新说明 v1.1.0
deploy/06-OTP二次验证实现.md OTP 二次验证实现
deploy/07-扫码登录OTP部署指南-v0.7.0.md 扫码登录OTP部署指南
deploy/08-NAS部署指南-预生产.md NAS部署指南(预生产)
deploy/09-NAS部署指南-群晖Cloudflare.md NAS部署指南(群晖)
deploy/10-一键部署操作包-v0.7.0.md 一键部署操作包
deploy/ 7
00-标准故障排查手册.md 标准故障排查手册(首查入口)
guides-用户指南/ 1

10-项目管理/

编号 文档 说明
01 01-任务总索引.md 任务管理文档体系总览
02 02-风险跟踪表.md 风险登记册(22项)
03 03-项目任务状态报告.md 历史全量任务(152个)
04 04-项目开发任务调整建议.md 任务调整建议
05 05-项目状态看板/01-项目状态看板.md 驾驶舱仪表盘
SOPs SOPs-标准流程/ 5项标准操作流程

11-历史归档/

历史归档文档,包含 -archived-日期 后缀


🔗 快速链接

场景 推荐文档
新人入职 01-项目总览/01-项目总览与部署手册-20260704.md
部署上线 01-项目总览/01-智能IT服务系统运维手册-20260704.md
故障排查 09-部署运维/00-标准故障排查手册.md
代码评审 07-代码评审/评审报告-代码评审/
安全合规 08-安全审计/
运维操作 10-项目管理/SOPs-标准流程/

📝 文档更新规则

更新类型 同步要求
新增文档 添加到对应目录 + 本索引
删除文档 从本索引移除
移动文档 更新本索引路径
重大变更 同步更新 CHANGELOG.md

📅 版本历史

版本 日期 变更
v2.0 2026-07-04 目录结构重组,完成重命名
v1.0 2026-07-04 初始版本,索引创建