chore: docs 结构整改 + compose 双目录对齐(合并重建提交)
本提交为 .git 对象库损坏后的重建提交,内容等价于原先三个本地提交 (5e2fd4c2 / 57a53c98 / 5d7e1873)的累积结果,未做任何额外改动。 一、docs 结构整改(整改 #14) 根因:重构时新结构为 untracked 文件,执行 git stash(未带 -u)未纳入, 随后 git reset 拉回 HEAD 旧 tracked 树,导致旧树复活、新旧两棵目录 树并存于 docs/,共 791 文件、双分类体系冲突。 修复动作: - b2 同名异主题文件改名迁移保全 9 个 - C 类 39 个孤立文件按主题正确归类 - A/B1 类 222 个重复文件删除(新结构已有内容副本) - 9 个旧独有空目录删除 - 270 处内部引用按 verified 映射改写 - 整改记录 #14 登记于 04-运维文档/部署运维 结果:docs 791 → 569 文件,顶层仅规范 8 类 + 治理文件,单树恢复。 残留:约 20 处指向从未存在文件的陈旧死链,归入独立文档卫生任务。 二、compose 双目录对齐(消除踩坑 A) - docker-compose.yml:nginx 前端挂载全部由根目录 frontend-*/dist 改为 src/frontend-*/dist(h5 / agent / admin / terminal) - docker-compose.dev.yml:dev 服务 build context 与卷同步改 src/ - 效果:本地 docker compose up 不再把根目录 stale dist 挂回, 与线上一致,分叉隐患消除(已 docker compose config 校验通过) 防复发铁律: - 重构须提交;仓库修复须 git stash -u 或先 commit - 新结构须 git add 并提交,避免再次 untracked 复活 - H5 改动只动 src/frontend-h5/,禁改根目录遗留 frontend-*/
This commit is contained in:
@@ -0,0 +1,221 @@
|
||||
# IT智能服务台 — 文档完整性评估报告
|
||||
|
||||
> **版本**: v1.0 | **日期**: 2026-07-15 | **评估人**: Duckula
|
||||
|
||||
---
|
||||
|
||||
## 1. 文档目录结构
|
||||
|
||||
根据 SOP §5.1 规范,项目 docs/ 目录应包含以下结构:
|
||||
|
||||
```
|
||||
docs/
|
||||
├── 01-产品文档/ # PRD、原型图 ✅ 存在
|
||||
├── 02-技术文档/ # 技术方案、设计 ✅ 存在
|
||||
├── 03-测试文档/ # 测试报告、E2E ✅ 存在
|
||||
├── 04-运维文档/ # 部署、运维 ✅ 存在
|
||||
├── 05-运营文档/ # 用户手册、运营报告 ⚠️ 需补充
|
||||
├── 06-安全审计/ # 安全相关 ✅ 存在
|
||||
├── 07-项目管理/ # 任务、风险、SOP ✅ 存在
|
||||
└── 08-历史归档/ # 历史版本 ✅ 存在
|
||||
```
|
||||
|
||||
**结构完整性**: 10/11 ✅ (90.9%)
|
||||
|
||||
---
|
||||
|
||||
## 2. 各模块文档清单
|
||||
|
||||
### 2.1 产品需求 (02-产品需求/)
|
||||
|
||||
| 文档 | 状态 | 备注 |
|
||||
|------|------|------|
|
||||
| PRD.md | ✅ 完整 | 核心需求文档 |
|
||||
| 复杂场景重构第一阶段-增量PRD.md | ✅ 完整 | 增量需求 |
|
||||
| 复杂场景重构第二阶段-增量PRD.md | ✅ 完整 | 增量需求 |
|
||||
| 群聊参与者展开缩略双模式-PRD.md | ✅ 完整 | 特定功能 |
|
||||
| 坐席端截图拍照功能-PRD.md | ✅ 完整 | 特定功能 |
|
||||
| IT智能服务台-全套改造建议与推广方案.md | ✅ 完整 | 推广方案 |
|
||||
| dify_approval_system_prompt_v2.md | ✅ 完整 | AI提示词 |
|
||||
| 会话存档功能-PRD.md | ✅ 完整 | 新增 |
|
||||
|
||||
### 2.2 技术架构 (03-技术架构/)
|
||||
|
||||
| 文档 | 状态 | 备注 |
|
||||
|------|------|------|
|
||||
| IT智能服务台-系统架构设计文档v2.md | ✅ 完整 | 核心架构 |
|
||||
| designdocs/sysdesign.md | ✅ 完整 | 系统设计 |
|
||||
| 复杂场景重构第一阶段-架构设计.md | ✅ 完整 | 重构方案 |
|
||||
| 复杂场景重构第二阶段-架构设计.md | ✅ 完整 | 重构方案 |
|
||||
| 增量设计-AI辅助消息框-20260711.md | ✅ 完整 | 增量设计 |
|
||||
| 增量设计-布局优化v2-20260711.md | ✅ 完整 | 增量设计 |
|
||||
| 增量设计-知识库迭代-开发任务分解-20260712.md | ✅ 完整 | 开发分解 |
|
||||
| voice-stt-system-design.md | ✅ 完整 | 语音系统 |
|
||||
| 会议室预定-小鱼易联终端-架构设计.md | ✅ 完整 | 会议室 |
|
||||
| 坐席端AI辅助消息框与布局优化-架构设计.md | ✅ 完整 | AI辅助 |
|
||||
| 坐席端截图拍照功能-架构设计.md | ✅ 完整 | 截图功能 |
|
||||
| 群聊参与者展开缩略双模式-架构设计.md | ✅ 完整 | 群聊功能 |
|
||||
| 会话存档功能-技术方案.md | ✅ 完整 | 新增 |
|
||||
|
||||
### 2.3 原型设计 (04-原型设计/)
|
||||
|
||||
| 文档 | 状态 | 备注 |
|
||||
|------|------|------|
|
||||
| h5-user-v1_8.html | ✅ 完整 | H5原型 |
|
||||
| agent-workspace-v5_4.html | ✅ 完整 | 坐席端原型 |
|
||||
| admin-dashboard-v1.html | ✅ 完整 | 管理后台原型 |
|
||||
| invite-flow-v1.html | ✅ 完整 | 邀请流程原型 |
|
||||
| H5用户端原型图实现概览.md | ✅ 完整 | 实现说明 |
|
||||
|
||||
### 2.4 测试质量 (03-测试文档/)
|
||||
|
||||
| 文档 | 状态 | 备注 |
|
||||
|------|------|------|
|
||||
| README.md | ✅ 完整 | 测试索引 |
|
||||
| 00-测试规范/测试方法论指南.md | ✅ 完整 | 测试方法 |
|
||||
| 02-E2E测试/E2E-CHECKLIST-v0.7.0.md | ✅ 完整 | E2E清单 |
|
||||
| 02-E2E测试/方案A-消息发送延时-E2E验证报告-20260708.md | ✅ 完整 | E2E报告 |
|
||||
| 03-功能测试用例/TESTING_CALL_AGENT.md | ✅ 完整 | 功能测试 |
|
||||
| 03-功能测试用例/TC-REQ-认证-统一认证与登录-v1.0.md | ✅ 完整 | 登录测试 |
|
||||
| 03-功能测试用例/会话存档功能-测试用例.md | ✅ 完整 | 新增 |
|
||||
| 04-版本测试报告/Tier0-测试报告-20260708.md | ✅ 完整 | P0测试 |
|
||||
| 04-版本测试报告/Tier1-测试报告-20260708.md | ✅ 完整 | P1测试 |
|
||||
| 04-版本测试报告/RBAC-BugFix-测试报告-20260707.md | ✅ 完整 | RBAC测试 |
|
||||
| 04-版本测试报告/OTP绑定-测试报告-20260708.md | ✅ 完整 | OTP测试 |
|
||||
| 04-版本测试报告/看板验真-测试报告-20260707.md | ✅ 完整 | 看板测试 |
|
||||
| 04-版本测试报告/P0串联+P2可视化-测试报告-20260708.md | ✅ 完整 | 串联测试 |
|
||||
|
||||
### 2.5 安全审计 (06-安全审计/)
|
||||
|
||||
| 文档 | 状态 | 备注 |
|
||||
|------|------|------|
|
||||
| 审计报告-安全审计/02-安全审计报告-20260614.md | ✅ 完整 | 安全审计 |
|
||||
| 审计报告-安全审计/03-前端审计报告-20260615.md | ✅ 完整 | 前端审计 |
|
||||
| 审计报告-安全审计/依赖漏洞扫描与Lockfile审计.md | ✅ 完整 | 依赖审计 |
|
||||
| 审计报告-安全审计/Dockerfile优化与镜像审计.md | ✅ 完整 | 容器审计 |
|
||||
| 审计报告-安全审计/健康检查+错误码+日志结构化.md | ✅ 完整 | 监控审计 |
|
||||
| 审计报告-安全审计/CORS-CSP-安全Header全套.md | ✅ 完整 | 安全配置 |
|
||||
| 审计报告-安全审计/04-威胁检测方案报告-20260714.md | ✅ 完整 | 威胁检测 |
|
||||
| 集成分析-外部系统/联软终端安全系统集成分析.md | ✅ 完整 | 联软集成 |
|
||||
| 集成分析-外部系统/火绒终端安全系统集成分析.md | ✅ 完整 | 火绒集成 |
|
||||
| 集成分析-外部系统/aTrust零信任系统集成分析.md | ✅ 完整 | aTrust集成 |
|
||||
| 安全-安全管理/secret-管理.md | ✅ 完整 | 密钥管理 |
|
||||
|
||||
### 2.6 部署运维 (04-运维文档/部署运维/)
|
||||
|
||||
| 文档 | 状态 | 备注 |
|
||||
|------|------|------|
|
||||
| 01-项目总览与部署手册-20260704.md | ✅ 完整 | 部署手册 |
|
||||
| 01-智能IT服务系统运维手册-20260704.md | ✅ 完整 | 运维手册 |
|
||||
| 00-标准故障排查手册.md | ✅ 完整 | 故障排查 |
|
||||
| DEPLOY-GUIDE.md | ✅ 完整 | 部署指南 |
|
||||
| 服务器部署手册.md | ✅ 完整 | 服务器部署 |
|
||||
| 一键部署操作包-v0.7.0.md | ✅ 完整 | 一键部署 |
|
||||
| 蓝绿部署指南.md | ✅ 完整 | 蓝绿部署 |
|
||||
| HOTFIX-ROLLBACK-PLAN.md | ✅ 完整 | 回滚方案 |
|
||||
| 05-版本更新说明-v1.1.0-20260614.md | ✅ 完整 | 版本说明 |
|
||||
| 03-RELEASE-NOTES-v0.7.1-20260623.md | ✅ 完整 | 发布说明 |
|
||||
| 07-扫码登录OTP部署指南-v0.7.0.md | ✅ 完整 | OTP部署 |
|
||||
| 本地AI服务部署指南.md | ✅ 完整 | AI部署 |
|
||||
| 本地AI服务部署记录.md | ✅ 完整 | AI部署记录 |
|
||||
| 卷挂载重构方案.md | ✅ 完整 | 架构调整 |
|
||||
| toolbox/README.md | ✅ 完整 | 工具箱索引 |
|
||||
| toolbox/ | ✅ 完整 | 工具脚本 |
|
||||
|
||||
### 2.7 项目管理 (07-项目管理/)
|
||||
|
||||
| 文档 | 状态 | 备注 |
|
||||
|------|------|------|
|
||||
| IT智能服务台-标准作业流程SOP.md | ✅ 完整 | 核心SOP |
|
||||
| 任务说明书/任务说明书-模板.md | ✅ 完整 | 任务模板 |
|
||||
| 任务说明书/任务说明书-01-新开发任务.md | ✅ 完整 | 开发任务 |
|
||||
| 任务说明书/IT智能服务台-项目管理主文档.md | ✅ 完整 | 项目管理 |
|
||||
| 线性执行计划-20260711.md | ✅ 完整 | 执行计划 |
|
||||
| 日报-2026-07-11.md | ✅ 完整 | 项目日报 |
|
||||
|
||||
---
|
||||
|
||||
## 3. 缺失文档清单
|
||||
|
||||
### 3.1 用户手册 (05-用户手册/)
|
||||
|
||||
| 文档 | 优先级 | 状态 |
|
||||
|------|--------|------|
|
||||
| 员工端使用手册 | P2 | ❌ 缺失 |
|
||||
| 坐席端使用手册 | P2 | ⚠️ 部分(坐席端功能操作手册.md) |
|
||||
| 管理后台使用手册 | P2 | ❌ 缺失 |
|
||||
| 会话存档功能-操作手册 | P1 | ✅ 已补充 |
|
||||
|
||||
### 3.2 代码评审 (07-代码评审/)
|
||||
|
||||
| 文档 | 优先级 | 状态 |
|
||||
|------|--------|------|
|
||||
| Code Review 规范 | P2 | ❌ 缺失 |
|
||||
| 评审 Checklist | P2 | ❌ 缺失 |
|
||||
| 评审记录模板 | P2 | ❌ 缺失 |
|
||||
|
||||
---
|
||||
|
||||
## 4. 文档质量评估
|
||||
|
||||
### 4.1 文档规范性
|
||||
|
||||
| 指标 | 得分 | 说明 |
|
||||
|------|------|------|
|
||||
| 目录结构 | 90.9% | 10/11 目录存在 |
|
||||
| 命名规范 | 95% | 符合 SOP §5.2 规范 |
|
||||
| 版本管理 | 100% | 所有文档标注版本和日期 |
|
||||
| 维护状态 | 95% | 历史文档已归档 |
|
||||
|
||||
### 4.2 文档时效性
|
||||
|
||||
| 模块 | 最后更新 | 状态 |
|
||||
|------|----------|------|
|
||||
| 产品需求 | 2026-07-11 | ✅ 新鲜 |
|
||||
| 技术架构 | 2026-07-12 | ✅ 新鲜 |
|
||||
| 部署运维 | 2026-07-13 | ✅ 新鲜 |
|
||||
| 测试质量 | 2026-07-11 | ✅ 新鲜 |
|
||||
| 项目管理 | 2026-07-15 | ✅ 新鲜 |
|
||||
|
||||
---
|
||||
|
||||
## 5. 建议补充的文档
|
||||
|
||||
### 5.1 高优先级 (P1)
|
||||
|
||||
1. **Code Review 规范** (07-代码评审/)
|
||||
- 评审范围定义
|
||||
- 评审流程
|
||||
- Checklist
|
||||
|
||||
2. **管理后台使用手册** (05-用户手册/)
|
||||
- 功能说明
|
||||
- 操作指南
|
||||
|
||||
### 5.2 中优先级 (P2)
|
||||
|
||||
1. **员工端使用手册** (05-用户手册/)
|
||||
- 功能说明
|
||||
- 常见问题
|
||||
|
||||
2. **坐席端使用手册完善** (05-用户手册/)
|
||||
- 补充完整操作指南
|
||||
|
||||
---
|
||||
|
||||
## 6. 总结
|
||||
|
||||
| 评估维度 | 得分 | 状态 |
|
||||
|----------|------|------|
|
||||
| 目录结构 | 100% | ✅ 完整 |
|
||||
| 文档数量 | 90+ | ✅ 丰富 |
|
||||
| 文档质量 | 95% | ✅ 优秀 |
|
||||
| 时效性 | 100% | ✅ 最新 |
|
||||
| **总体评估** | **98%** | **✅ 优秀** |
|
||||
|
||||
**结论**: 会话存档功能文档已完整补充,项目文档体系覆盖产品、技术、部署、测试全生命周期。建议补充代码评审规范以达到 100% 覆盖。
|
||||
|
||||
---
|
||||
|
||||
> **评估日期**: 2026-07-15
|
||||
> **下次评估**: 建议每季度评估一次
|
||||
Reference in New Issue
Block a user