docs/v1.0/server/rfcs/102-fix-service-docs.md

服务文档重组

执行时间：2025-01-14
执行人：系统架构师

---

问题描述

原有的 04-services 目录下有 19 个服务文档，全部平铺在同一层级，随着服务数量增加，查找和维护变得困难。

---

解决方案

按业务领域将服务文档分类到子目录：

重组前

04-services/
├── user-service.md
├── sms-service.md
├── wechat-service.md
├── credit-service.md
├── recharge-service.md
├── payment-service.md
├── project-service.md
├── folder-service.md
├── script-service.md
├── storyboard-service.md
├── timeline-service.md
├── comment-service.md
├── export-service.md
├── project-resource-service.md
├── resource-service.md
├── attachment-service.md
├── file-storage-service.md
├── ai-service.md
└── video-service.md

重组后

04-services/
├── README.md                    # 总览文档
├── user/                        # 用户相关服务（6个）
│   ├── README.md
│   ├── user-service.md
│   ├── sms-service.md
│   ├── wechat-service.md
│   ├── credit-service.md
│   ├── recharge-service.md
│   └── payment-service.md
├── project/                     # 项目相关服务（8个）
│   ├── README.md
│   ├── project-service.md
│   ├── project-resource-service.md
│   ├── folder-service.md
│   ├── script-service.md
│   ├── storyboard-service.md
│   ├── timeline-service.md
│   ├── comment-service.md
│   └── export-service.md
├── resource/                    # 资源相关服务（3个）
│   ├── README.md
│   ├── resource-service.md
│   ├── attachment-service.md
│   └── file-storage-service.md
└── ai/                          # AI相关服务（2个）
    ├── README.md
    ├── ai-service.md
    └── video-service.md

---

执行步骤

1. ✅ 创建子目录：user/、project/、resource/、ai/
2. ✅ 移动文件到对应目录
3. ✅ 为每个子目录创建 README.md 索引文档
4. ✅ 创建总览 README.md

---

分类依据

user/ - 用户相关服务

• 用户认证、授权
• 积分管理
• 充值支付
• 第三方登录

project/ - 项目相关服务

• 项目管理
• 项目资源
• 脚本、分镜、时间轴
• 协作评论
• 导出功能

resource/ - 资源相关服务

• 素材资源管理
• 文件附件
• 云存储

ai/ - AI 相关服务

• AI 生成
• 视频处理

---

优势

1. 清晰的业务边界：每个目录代表一个业务领域
2. 易于查找：按业务功能快速定位文档
3. 便于维护：相关服务集中管理
4. 扩展性好：新增服务直接放入对应目录
5. 符合微服务架构：与代码结构保持一致

---

影响范围

文档引用路径变更

如果其他文档引用了这些服务文档，需要更新路径：

旧路径：

[用户管理服务](../04-services/user-service.md)

新路径：

[用户管理服务](../04-services/user/user-service.md)

需要检查的文档

• docs/方案/*.md
• docs/计划/*.md
• docs/需求/backend/*.md

---

后续优化

1. 检查并更新所有文档中的引用路径
2. 在 IDE 中配置路径别名，方便跳转
3. 考虑添加自动化脚本检查文档链接有效性

---

执行时间：2025-01-14
状态：✅ 已完成