martial/martial-web

Fork 0

Files

宅房 5b806e29b7

continuous-integration/drone/push Build is failing

Details

fix bugs

2025-12-11 16:56:19 +08:00

5.9 KiB

Raw Permalink Blame History

编排模块文档索引

本目录包含编排模块的所有技术文档和历史版本

📚 主文档

当前版本

编排系统完整指南 - v1.0
- 最后更新：2025-12-10
- 状态：已发布
- 简介：编排系统的完整技术方案，包含架构设计、数据库设计、前后端实现、API文档等

📁 文档结构

schedule/
├── README.md                           # 本文件 - 编排模块文档索引
├── schedule-complete-guide.md          # 主文档 - 编排系统完整指南（当前版本）
├── versions/                           # 历史版本目录
│   ├── CHANGELOG.md                    # 版本更新日志
│   ├── v1.0/
│   │   └── schedule-complete-guide-v1.0.md
│   └── v1.1/ (未来版本)
│       └── schedule-complete-guide-v1.1.md
└── archive/                            # 已废弃的旧文档
    ├── schedule-system-analysis.md     # 已废弃 - 系统分析文档
    ├── schedule-system-design.md       # 已废弃 - 系统设计文档
    ├── schedule-feature-implementation.md
    ├── schedule-backend-implementation-summary.md
    ├── schedule-backend-api-spec.md
    ├── schedule-api-conflict-fix.md
    ├── schedule-ui-test-guide.md
    ├── schedule-ui-update-summary.md
    └── schedule-performance-optimization.md

📖 文档说明

主文档

schedule-complete-guide.md 是编排模块的核心技术文档，包含以下内容：

系统概述 - 功能简介、技术栈
架构设计 - 系统架构图、模块划分
数据库设计 - 核心表设计、表关系图
后端实现 - Controller层、Service层、Mapper层
前端实现 - 页面结构、数据结构、核心方法
数据流转 - 完整流程图、数据库操作流程
核心功能 - 场地过滤、顺序调整、分组移动、异常标记等
API接口文档 - 详细的接口说明和示例
关键代码解析 - 重要代码段的详细说明
使用指南 - 操作流程、常见问题、调试方法

历史版本

所有发布的版本都会保存在 versions/ 目录下，按版本号组织：

versions/v1.0/ - 第一个正式版本
versions/v1.1/ - 功能优化版本（未来）
versions/CHANGELOG.md - 记录所有版本的更新内容

已废弃文档

archive/ 目录存放已不再维护的旧文档，这些文档可能包含过时的信息或已被主文档整合：

schedule-system-analysis.md - 早期的系统分析文档
schedule-system-design.md - 早期的设计文档
schedule-feature-implementation.md - 功能实现记录
schedule-backend-implementation-summary.md - 后端实现总结
schedule-backend-api-spec.md - API规范文档
schedule-api-conflict-fix.md - API冲突修复记录
schedule-ui-test-guide.md - UI测试指南
schedule-ui-update-summary.md - UI更新总结
schedule-performance-optimization.md - 性能优化方案

⚠️ 注意：archive 目录中的文档仅供参考，可能包含过时信息，请以主文档为准。

🔄 版本管理

版本号规则

主版本号 (Major): 重大功能变更或架构调整 (v1.0 → v2.0)
次版本号 (Minor): 功能新增或优化 (v1.0 → v1.1)
修订号 (Patch): 文档修正、补充说明 (v1.0.1 → v1.0.2)

更新流程

日常修改：直接在主文档 schedule-complete-guide.md 中修改
发布新版本：
- 将当前主文档复制到 versions/vX.X/ 目录
- 更新 versions/CHANGELOG.md 记录变更
- 在主文档头部更新版本号和更新日期

示例

# 当前主文档版本: v1.0
doc/schedule/schedule-complete-guide.md

# 发布 v1.1 版本的步骤:
1. 复制主文档到历史版本目录
   cp schedule-complete-guide.md versions/v1.0/schedule-complete-guide-v1.0.md

2. 修改主文档内容，更新版本号为 v1.1

3. 更新 versions/CHANGELOG.md，记录 v1.1 的变更内容

4. 更新本 README.md，在主文档说明中更新版本号

📝 快速导航

我想了解...

整体架构 → 完整指南 - 架构设计
数据库表结构 → 完整指南 - 数据库设计
API接口 → 完整指南 - API接口文档
前端实现 → 完整指南 - 前端实现
后端实现 → 完整指南 - 后端实现
如何使用 → 完整指南 - 使用指南
数据流转 → 完整指南 - 数据流转

我遇到问题...

编排数据为空 → 完整指南 - 常见问题
无法编辑 → 完整指南 - 常见问题
保存失败 → 完整指南 - 常见问题
调试方法 → 完整指南 - 开发调试

📅 版本历史

版本	发布日期	主要更新	文档链接
v1.0	2025-12-10	初始版本，完整技术方案	查看文档

详细的版本更新记录请查看 CHANGELOG.md

🔗 相关文档

最后更新: 2025-12-10

5.9 KiB Raw Permalink Blame History Unescape Escape