武术赛事管理系统 - 文档中心
本目录包含项目的所有技术文档，按模块和版本组织
📁 文档目录结构
doc/
├── README.md # 文档中心首页（本文件）
├── schedule/ # 编排模块文档
│ ├── README.md # 编排模块文档索引
│ ├── schedule-complete-guide.md # 编排系统完整指南（最新版本）
│ ├── versions/ # 历史版本
│ │ ├── v1.0/
│ │ │ └── schedule-complete-guide-v1.0.md
│ │ ├── v1.1/
│ │ │ └── schedule-complete-guide-v1.1.md
│ │ └── CHANGELOG.md # 版本更新日志
│ └── archive/ # 已废弃的旧文档
│ ├── schedule-system-analysis.md
│ ├── schedule-system-design.md
│ └── ...
├── registration/ # 报名模块文档
│ ├── README.md
│ └── registration-performance-optimization.md
├── image/ # 文档图片资源
│ └── ...
└── templates/ # 文档模板
└── feature-doc-template.md
📚 主要文档
编排模块
| 文档名称 | 版本 | 更新日期 | 说明 |
|---|---|---|---|
| 编排系统完整指南 | v1.0 | 2025-12-10 | 主文档 - 编排系统的完整技术方案 |
| 编排模块索引 | - | 2025-12-10 | 编排模块所有文档的导航 |
报名模块
| 文档名称 | 版本 | 更新日期 | 说明 |
|---|---|---|---|
| 报名性能优化 | v1.0 | 2025-12-10 | 报名功能的性能优化方案 |
🔄 文档版本管理规范
版本号规则
- 主版本号 (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记录变更 - 更新模块的
README.md索引
- 将当前主文档复制到
-
归档废弃文档
- 将不再维护的旧文档移到
archive/目录 - 在文档顶部添加 已废弃 标记
- 将不再维护的旧文档移到
示例
# 当前版本: v1.0
doc/schedule/schedule-complete-guide.md
# 发布 v1.1 版本
1. 复制 schedule-complete-guide.md → versions/v1.0/schedule-complete-guide-v1.0.md
2. 修改 schedule-complete-guide.md 内容（版本号改为 v1.1）
3. 更新 versions/CHANGELOG.md
4. 更新 schedule/README.md
📝 文档编写规范
文档命名
- 使用小写字母和连字符
- 格式:
{模块名}-{文档类型}.md - 例如:
schedule-complete-guide.md,registration-api-spec.md
文档头部信息
每个文档都应包含以下头部信息：
# 文档标题
> **版本**: vX.X.X
> **创建日期**: YYYY-MM-DD
> **最后更新**: YYYY-MM-DD
> **文档作者**: 作者名
> **状态**: 草稿 / 审核中 / 已发布 / 已废弃
文档目录
- 使用
## 目录章节 - 每个一级标题对应一个锚点
- 保持目录结构清晰
🔗 相关资源
📧 文档反馈
如发现文档问题或有改进建议，请：
- 提交 Issue: GitHub Issues
- 联系开发团队: dev@example.com
文档中心最后更新: 2025-12-10