47 lines
2.9 KiB
Markdown
47 lines
2.9 KiB
Markdown
# Sport Era 文档索引
|
|
|
|
> 新增项目级文档统一存放在 [`docs/`](./docs/)；根目录仅保留本索引及项目入口说明。源码子目录中的 README、AGENTS 等模块说明继续就近维护。
|
|
|
|
## 项目管理
|
|
|
|
- [业务进度管理](./docs/业务进度管理.md)：已完成、进行中和待办事项，以及避坑记录。
|
|
- [设计稿映射](./docs/设计稿映射.md)：设计稿与页面、组件的映射关系。
|
|
- [产品方案文档](./docs/01-产品方案文档.md)：产品定位、功能规划与技术方案。
|
|
- [实现流程文档](./docs/02-实现流程文档.md)：项目实现步骤与流程说明。
|
|
|
|
## 功能设计与实施记录
|
|
|
|
- [赛事中心赛程、直播、赔率组件设计](./docs/赛事中心赛程直播赔率组件设计.md)
|
|
- [赛事中心赛程、直播、赔率组件实施计划](./docs/赛事中心赛程直播赔率组件实施计划.md)
|
|
- [比赛详情赔率绑定设计](./docs/比赛详情赔率绑定设计.md)
|
|
- [比赛详情赔率绑定实施计划](./docs/比赛详情赔率绑定实施计划.md)
|
|
- [赔率平台皇冠展示名设计](./docs/赔率平台皇冠展示名设计.md)
|
|
- [赔率平台皇冠展示名实施计划](./docs/赔率平台皇冠展示名实施计划.md)
|
|
- [直播间功能设计规格](./docs/superpowers/specs/2026-06-21-match-live-streams-design.md)
|
|
|
|
## 运维与爬虫
|
|
|
|
- [测试服务器运行环境](./docs/服务器运行环境.md)：服务器资源、宿主机服务、Docker 容器与当前风险快照。
|
|
- [Gitea 部署说明](./docs/Gitea部署说明.md)：Gitea 的访问地址、持久化数据、运维命令与首次初始化步骤。
|
|
- [爬虫任务脚本文档](./docs/爬虫任务脚本文档.md)：爬虫任务的功能和执行说明。
|
|
- [Docker crawler 说明](./docker/crawler/README.md)：爬虫容器的源码级说明。
|
|
|
|
## 数据库脚本
|
|
|
|
- [`docs/sql/`](./docs/sql/)：数据库表、字段、索引、配置、菜单和定时任务的初始化或变更 SQL。
|
|
- 命名约定：`create_` 为建表，`alter_` 为字段调整，`insert_` 为配置、菜单或定时任务初始化，`fix_` 为数据修复。
|
|
- 执行前以当前代码与数据库结构为准；SQL 必须保持幂等，且不得将数据库密码写入脚本或文档。
|
|
|
|
## 模块说明
|
|
|
|
- [后端说明](./server/README.md) / [后端规范](./server/AGENTS.md)
|
|
- [管理后台说明](./admin/README.md) / [管理后台规范](./admin/AGENTS.md)
|
|
- [手机端说明](./uniapp/README.md) / [手机端规范](./uniapp/AGENTS.md)
|
|
- [PC 前台说明](./pc/README.md) / [PC 前台规范](./pc/AGENTS.md)
|
|
|
|
## 文档维护规则
|
|
|
|
1. 新增项目级文档先放入 `docs/`，再补充本索引的对应链接。
|
|
2. 设计或实现变更完成后，同步更新 [业务进度管理](./docs/业务进度管理.md)；涉及页面设计时同步更新 [设计稿映射](./docs/设计稿映射.md)。
|
|
3. 服务器状态文档是快照，任何后续部署、容器重建或资源变化后，应重新采集并更新采集时间。
|