107 lines
4.2 KiB
Markdown
107 lines
4.2 KiB
Markdown
|
# 射箭赛事平台文档仓库
|
||
|
|
|
||
|
|
## 1. 项目说明
|
||
|
|
本仓库用于梳理“射箭赛事平台”的业务文档、系统说明和开发前置资料，后续可直接提供给 agent 进行代码开发、接口设计、测试用例整理与任务拆解。
|
||
|
|
|
||
|
|
## 2. 代码工程范围
|
||
|
|
当前平台包含 4 个核心代码工程：
|
||
|
|
|
||
|
|
| 工程 | 面向对象 | 主要职责 |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| 微信小程序 | 参赛用户 | 浏览赛事、报名支付、查看通知与成绩 |
|
||
|
|
| 商户后台 | 赛事入驻方 | 入驻申请、赛事发布、报名管理、成绩录入 |
|
||
|
|
| 管理后台 | 平台运营人员 | 审核商户、审核赛事、风控治理、报表统计 |
|
||
|
|
| 后台 API 服务 | 全部客户端 | 提供统一接口、权限控制、订单支付、成绩与消息能力 |
|
||
|
|
|
||
|
|
## 3. 当前文档目录
|
||
|
|
|
||
|
|
```text
|
||
|
|
archery-event/
|
||
|
|
├── README.md
|
||
|
|
├── 01-基础与总览/
|
||
|
|
├── 02-用户侧流程/
|
||
|
|
├── 03-商户侧流程/
|
||
|
|
├── 04-平台治理流程/
|
||
|
|
├── 05-通用基础/
|
||
|
|
├── 06-微信小程序说明/
|
||
|
|
├── 07-商户后台说明/
|
||
|
|
├── 08-管理后台说明/
|
||
|
|
├── 09-后台API说明/
|
||
|
|
├── 10-项目执行/
|
||
|
|
└── 11-项目验收/
|
||
|
|
```
|
||
|
|
|
||
|
|
## 4. 推荐阅读顺序
|
||
|
|
### 第 1 层：先理解业务
|
||
|
|
1. `01-基础与总览/README.md`
|
||
|
|
2. `01-基础与总览/核心业务流程总览.md`
|
||
|
|
3. `01-基础与总览/角色与场景地图.md`
|
||
|
|
4. `01-基础与总览/业务名词表.md`
|
||
|
|
|
||
|
|
### 第 2 层：再看核心闭环
|
||
|
|
5. `03-商户侧流程/商户入驻流程.md`
|
||
|
|
6. `03-商户侧流程/赛事创建与发布流程.md`
|
||
|
|
7. `02-用户侧流程/用户报名参赛流程.md`
|
||
|
|
8. `02-用户侧流程/支付流程.md`
|
||
|
|
9. `02-用户侧流程/退款流程.md`
|
||
|
|
10. `03-商户侧流程/成绩录入与排名流程.md`
|
||
|
|
|
||
|
|
### 第 3 层：补充规则与治理
|
||
|
|
11. `03-商户侧流程/赛事规则与计分模型.md`
|
||
|
|
12. `04-平台治理流程/状态流转总表.md`
|
||
|
|
13. `02-用户侧流程/消息通知与触达流程.md`
|
||
|
|
14. `04-平台治理流程/结算与对账流程.md`
|
||
|
|
15. `04-平台治理流程/异常处理与申诉流程.md`
|
||
|
|
16. `01-基础与总览/业务规则待确认清单.md`
|
||
|
|
|
||
|
|
### 第 4 层：最后交给开发实现
|
||
|
|
17. `05-通用基础/README.md`
|
||
|
|
18. `05-通用基础/系统架构总览.md`
|
||
|
|
19. `05-通用基础/角色与权限矩阵.md`
|
||
|
|
20. `05-通用基础/核心数据模型草案.md`
|
||
|
|
21. `09-后台API说明/领域模块划分.md`
|
||
|
|
22. `09-后台API说明/接口清单规划.md`
|
||
|
|
|
||
|
|
### 第 5 层：进入执行与验收
|
||
|
|
23. `10-项目执行/README.md`
|
||
|
|
24. `10-项目执行/模块实施总任务单.md`
|
||
|
|
25. `11-项目验收/README.md`
|
||
|
|
26. `11-项目验收/功能验收标准总表.md`
|
||
|
|
|
||
|
|
## 5. 文档编写原则
|
||
|
|
- 文档默认使用中文。
|
||
|
|
- 优先明确业务边界、角色职责、状态流转和关键数据对象。
|
||
|
|
- 当前技术栈未定，先不绑定具体框架实现。
|
||
|
|
- 所有新增术语应同步更新到 `01-基础与总览/业务名词表.md`。
|
||
|
|
- 一条业务规则有变化时，应同步更新相关流程文档、状态文档和接口说明。
|
||
|
|
|
||
|
|
## 6. 当前优先级
|
||
|
|
- **P0**：商户入驻流程
|
||
|
|
- **P0**：赛事创建与发布流程
|
||
|
|
- **P1**：用户报名参赛流程
|
||
|
|
- **P1**：支付流程
|
||
|
|
- **P1**：退款流程
|
||
|
|
- **P1**：成绩录入与排名流程
|
||
|
|
- **P2**：通知、结算、异常、报表与交付规范
|
||
|
|
|
||
|
|
## 7. 交给 agent 前建议至少补齐的内容
|
||
|
|
只要把下面这些信息补完整，就已经足以让 agent 分阶段做出较完整的平台：
|
||
|
|
|
||
|
|
1. **赛事规则**
|
||
|
|
- 支持哪些赛制、组别、计分方式、同分规则
|
||
|
|
2. **支付与退款规则**
|
||
|
|
- 退款时限、手续费承担、结算周期、抽佣规则
|
||
|
|
3. **审核规则**
|
||
|
|
- 商户和赛事的审核标准、驳回原因模板、白名单机制
|
||
|
|
4. **页面字段与表单项**
|
||
|
|
- 各页面要展示哪些字段、各表单必填项是什么
|
||
|
|
5. **接口字段细节**
|
||
|
|
- 请求参数、返回字段、错误码、分页与筛选条件
|
||
|
|
6. **技术选型**
|
||
|
|
- 前端框架、后端语言、数据库、部署环境
|
||
|
|
|
||
|
|
## 8. 下一步建议
|
||
|
|
1. 先补齐 `10-项目执行/模块实施总任务单.md` 中每个任务的具体业务细节。
|
||
|
|
2. 用 `10-项目执行/Agent任务派发模板.md` 把任务逐批交给 agent 执行。
|
||
|
|
3. 开发完成后按 `11-项目验收/` 目录逐项做联调、验收与上线检查。
|