Simon
260 lines
10 KiB
Markdown
260 lines
10 KiB
Markdown
# 文档分类与清理报告
|
||
|
||
> **生成日期**: 2026-07-04 | **维护人**: 助理（小米）
|
||
> **执行状态**: ✅ 已执行（2026-07-04 02:05）
|
||
|
||
---
|
||
|
||
## 一、文档统计
|
||
|
||
| 类别 | 数量 | 说明 |
|
||
|------|------|------|
|
||
| **当前有效文档** | ~40 | 正在使用的主文档 |
|
||
| **已归档文档** | 37 | 已移至 archive，需保留参考 |
|
||
| **原型文件** | 5 当前 + 17 归档 | 保留当前使用版本 |
|
||
| **证书文件** | 0 | 已删除（敏感） |
|
||
| **总计** | ~95 | |
|
||
|
||
---
|
||
|
||
## 二、文档分类结构
|
||
|
||
### 2.1 推荐的目录结构
|
||
|
||
```
|
||
docs/
|
||
├── 01-项目总览/ # 项目介绍、架构
|
||
│ ├── 01-项目总览与部署手册.md (主文档)
|
||
│ ├── PRD.md (产品需求)
|
||
│ └── IT智能服务台-技术架构设计.md
|
||
│
|
||
├── 02-运维手册/ # 部署、运维、监控
|
||
│ ├── 智能IT服务系统运维手册.md (主文档)
|
||
│ ├── deploy/ (部署相关)
|
||
│ │ ├── 快速诊断-500-错误.md
|
||
│ │ ├── HOTFIX-ROLLBACK-PLAN.md
|
||
│ │ ├── 服务器端跑诊断.md
|
||
│ │ └── set-real-ip-patch.md
|
||
│ └── SOPs/ (标准操作流程)
|
||
│ ├── SOP-001-Gitea部署.md
|
||
│ ├── SOP-002-Gitea备份恢复.md
|
||
│ ├── SOP-003-推送评审.md
|
||
│ └── SOP-004-应急响应.md
|
||
│
|
||
├── 03-产品设计/ # 产品方案、原型
|
||
│ ├── 邀请功能-技术方案.md
|
||
│ ├── 摇人-多坐席协作-技术方案.md
|
||
│ ├── 消息功能详细方案.md
|
||
│ ├── OTP二次验证实现.md
|
||
│ └── H5用户端右侧栏动态推送评估.md
|
||
│
|
||
├── 04-集成分析/ # 第三方系统集成
|
||
│ ├── 火绒终端安全系统集成分析.md
|
||
│ ├── 联软终端安全系统集成分析.md
|
||
│ ├── aTrust零信任系统集成分析.md
|
||
│ └── ExternalSystemAdapter设计文档.md
|
||
│
|
||
├── 05-项目管理/ # 任务、看板、评审
|
||
│ ├── 小组任务书/
|
||
│ │ ├── 任务执行状态看板.md
|
||
│ │ ├── 01-小组A-认证加固组-计划任务书.md
|
||
│ │ ├── 02-小组B-消息系统组-计划任务书.md
|
||
│ │ ├── 03-小组C-AI与数据组-计划任务书.md
|
||
│ │ ├── D-T19-知识图谱数据模型设计.md
|
||
│ │ ├── D-T20-Dify集成方案.md
|
||
│ │ └── A-T12-集成测试报告.md
|
||
│ ├── 评审报告/
|
||
│ ├── 路线图/
|
||
│ └── 项目任务状态报告_2026-06-13.md
|
||
│
|
||
├── 06-审计安全/ # 安全、审计
|
||
│ ├── 安全/
|
||
│ │ └── secret-管理.md
|
||
│ ├── 安全审计报告.md
|
||
│ ├── 前端审计报告.md
|
||
│ └── 审计报告/
|
||
│ ├── CORS-CSP-安全Header全套.md
|
||
│ ├── Dockerfile优化与镜像审计.md
|
||
│ ├── 依赖漏洞扫描与Lockfile审计.md
|
||
│ └── 健康检查+错误码+日志结构化.md
|
||
│
|
||
├── 07-团队与流程/ # 团队、流程文档
|
||
│ ├── ADRs/ (架构决策记录)
|
||
│ │ ├── ADR-001-Gitea自托管-Funnel暴露.md
|
||
│ │ ├── ADR-002-WS-Token-Subprotocol鉴权.md
|
||
│ │ ├── ADR-003-nginx-access_log关闭.md
|
||
│ │ └── ADR-004-Token不入文件-走wincred.md
|
||
│ ├── 风险跟踪表.md
|
||
│ ├── 资源申请清单.md
|
||
│ ├── 项目开发任务调整建议-20260611.md
|
||
│ └── 并行开发启动通知.md
|
||
│
|
||
├── 08-发布记录/ # 版本、发布
|
||
│ ├── RELEASE_NOTES_v0.7.1.md
|
||
│ ├── RELEASE_NOTES_v0.5.0-beta.md
|
||
│ ├── 智能IT支持服务台-版本更新说明-20250614.md
|
||
│ └── 智能IT支持服务台-项目迁移文档.md
|
||
│
|
||
├── 09-参考模板/ # 参考文档、模板
|
||
│ ├── 调试验证指南_2026-06-13.md
|
||
│ ├── E2E-CHECKLIST-v0.7.0.md
|
||
│ ├── 数据库ER图与环境变量清点.md
|
||
│ ├── 域名申请邮件-itsupport-servyou-com-cn.md
|
||
│ ├── Gitea部署指南.md
|
||
│ └── 团队沟通文档-架构消息知识库.md
|
||
│
|
||
├── 10-图表/ # Mermaid 图表
|
||
│ └── diagrams/
|
||
│
|
||
├── 11-原型/ # HTML 原型
|
||
│ ├── prototypes/
|
||
│ │ ├── h5-user-wecom-style-v2-desktop.html (当前H5桌面版)
|
||
│ │ ├── h5-user-wecom-style-v2-mobile.html (当前H5移动版)
|
||
│ │ ├── agent-workspace-v5_4.html (当前坐席版)
|
||
│ │ ├── admin-dashboard-v1.html (当前管理后台)
|
||
│ │ ├── invite-flow-v1.html (邀请功能)
|
||
│ │ └── archive/ (历史版本)
|
||
│ └── dashboard.html
|
||
│
|
||
├── archive/ # 已归档（历史版本）
|
||
│
|
||
└── 智能IT服务系统运维手册.md (运维入口文档)
|
||
```
|
||
|
||
---
|
||
|
||
## 三、重复/冲突内容识别
|
||
|
||
### 3.1 功能重复
|
||
|
||
| 文档A | 文档B | 重复内容 | 建议 |
|
||
|-------|-------|----------|------|
|
||
| `01-项目总览与部署手册.md` | `IT智能服务台-技术架构设计.md` | 部分架构描述重复 | 保留 `01-项目总览`，后者移至 archive |
|
||
| `deploy/服务器端跑诊断.md` | `deploy/快速诊断-500-错误.md` | 部分诊断步骤重复 | 整合到运维手册 |
|
||
| `项目任务状态报告_2026-06-13.md` | `小组任务书/任务执行状态看板.md` | 任务状态内容重复 | 保留看板，报告移至 archive |
|
||
| `路线图/阶段2-3-任务.md` | `路线图/阶段4-5-规划.md` | 路线图内容 | 合并到 `路线图/` 统一管理 |
|
||
| `评审报告/workbuddy-2026-06-14-消息优化.md` | `评审报告/workbuddy-2026-06-14-消息优化-P1二次评审.md` | 同一主题评审 | 保留最新版本 |
|
||
|
||
### 3.2 版本重复
|
||
|
||
| 文档 | 说明 | 建议 |
|
||
|------|------|------|
|
||
| `RELEASE_NOTES_v0.7.1.md` | v0.7.1 版本发布说明 | 保留 |
|
||
| `RELEASE_NOTES_v0.5.0-beta.md` | v0.5.0 测试版说明 | 移至 archive |
|
||
| `智能IT支持服务台-版本更新说明-20250614.md` | 2025年06月14日版本说明 | 移至 archive |
|
||
|
||
### 3.3 过时内容
|
||
|
||
| 文档 | 问题 | 建议 |
|
||
|------|------|------|
|
||
| `IT服务台部署修复记录-2026-06-13.md` | 历史修复记录，已过时效 | 移至 archive |
|
||
| `项目全面评估报告-2026-06-25.md` | 阶段性评估报告 | 移至 archive |
|
||
| `aTrust零信任系统集成分析.md` | 分析报告，未实际实施 | 保留（供参考） |
|
||
| `调试验证指南_2026-06-13.md` | 阶段性验证指南 | 移至 archive |
|
||
|
||
### 3.4 原型版本过多
|
||
|
||
| 目录 | 数量 | 说明 |
|
||
|------|------|------|
|
||
| `prototypes/` | 17 个 | 包含多个版本号（v1_1, v1_2...）|
|
||
| `prototypes/archive/` | 5 个 | 已有归档目录 |
|
||
|
||
**建议**: 保留当前使用的版本（v2, v5_4 等），其余移至 archive
|
||
|
||
---
|
||
|
||
## 四、待清理清单
|
||
|
||
### 4.1 立即可删除（过期/已废弃）
|
||
|
||
| 文件 | 原因 |
|
||
|------|------|
|
||
| `docs/IT服务台部署修复记录-2026-06-13.md` | 历史记录，已过时效 |
|
||
| `docs/项目全面评估报告-2026-06-25.md` | 阶段性报告 |
|
||
| `docs/调试验证指南_2026-06-13.md` | 阶段性验证指南 |
|
||
| `docs/RELEASE_NOTES_v0.5.0-beta.md` | 旧版本发布说明 |
|
||
| `docs/智能IT支持服务台-版本更新说明-20250614.md` | 旧版本说明 |
|
||
| `docs/项目任务状态报告_2026-06-13.md` | 已被看板替代 |
|
||
| `docs/智能IT支持服务台-项目迁移文档.md` | 历史迁移文档 |
|
||
| `docs/现有系统交接文档内容.txt` | 交接内容（检查是否需要）|
|
||
|
||
### 4.2 移至 archive（保留参考）
|
||
|
||
| 文件 | 原因 |
|
||
|------|------|
|
||
| `docs/IT智能服务台-技术架构设计.md` | 与 `01-项目总览` 部分重复 |
|
||
| `docs/消息功能详细方案.md` | 功能方案文档，可归档 |
|
||
| `docs/摇人-多坐席协作-技术方案.md` | 已实现，可归档 |
|
||
| `docs/邀请功能-技术方案.md` | 已实现，可归档 |
|
||
| `docs/OTP二次验证实现.md` | 已实现，可归档 |
|
||
| `docs/H5用户端右侧栏动态推送评估.md` | 评估报告，可归档 |
|
||
| `docs/ExternalSystemAdapter设计文档.md` | 设计文档，可归档 |
|
||
| `docs/项目开发任务调整建议-20260611.md` | 历史任务调整 |
|
||
| `docs/风险跟踪表.md` | 历史风险表 |
|
||
| `docs/前端审计报告.md` | 历史审计 |
|
||
| `docs/安全审计报告.md` | 历史审计 |
|
||
| `docs/团队沟通文档-架构消息知识库.md` | 历史沟通文档 |
|
||
| `docs/需求-发布预演页面.md` | 历史需求 |
|
||
|
||
### 4.3 证书文件处理
|
||
|
||
| 文件 | 位置 | 建议 |
|
||
|------|------|------|
|
||
| `servyou.com.cn (1)/` | docs/ | **移动到安全位置或删除**，不应放在代码库 |
|
||
|
||
### 4.4 原型整理
|
||
|
||
| 操作 | 目标 |
|
||
|------|------|
|
||
| 保留 | `h5-user-wecom-style-v2-desktop.html`, `h5-user-wecom-style-v2-mobile.html`, `agent-workspace-v5_4.html`, `admin-dashboard-v1.html`, `invite-flow-v1.html` |
|
||
| 移至 archive | 其余所有带版本号的原型文件 |
|
||
|
||
---
|
||
|
||
## 五、待确认事项
|
||
|
||
> 请确认以下处理方式：
|
||
|
||
1. **证书文件** (`servyou.com.cn (1)/`) - 是否删除？
|
||
2. **过时文档** - 是否按建议移至 archive？
|
||
3. **原型文件** - 是否按建议整理？
|
||
4. **目录结构调整** - 是否按新结构重组？
|
||
|
||
---
|
||
|
||
## 六、清理后的目标结构
|
||
|
||
```
|
||
docs/ # 约 30-35 个核心文档
|
||
├── 01-项目总览/
|
||
├── 02-运维手册/
|
||
├── 03-产品设计/
|
||
├── 04-集成分析/
|
||
├── 05-项目管理/
|
||
├── 06-审计安全/
|
||
├── 07-团队与流程/
|
||
├── 08-发布记录/
|
||
├── 09-参考模板/
|
||
├── 10-图表/
|
||
├── 11-原型/
|
||
├── archive/ # 约 40-50 个归档文档
|
||
└── 智能IT服务系统运维手册.md (入口)
|
||
```
|
||
|
||
---
|
||
|
||
## 七、执行计划
|
||
|
||
确认后，我将按以下顺序执行：
|
||
|
||
1. 删除证书文件
|
||
2. 移动过时文档到 archive
|
||
3. 整理原型文件
|
||
4. 创建/更新分类目录说明文档
|
||
5. 更新 MEMO 文件
|
||
|
||
---
|
||
|
||
> **维护人**: 助理（小米）
|
||
> **下次评审**: 每次版本发布时
|