docs/00-overview.md
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
# WMS SaaS 项目文档索引
|
||||
|
||||
本目录由根目录 `README.md`(项目总提示词)按主题拆分而来,是项目设计与开发的约束来源。
|
||||
|
||||
| 文档 | 内容 | 对应原 README 章节 |
|
||||
| --- | --- | --- |
|
||||
| [00-overview.md](./00-overview.md) | 项目定位、最终目标 | 开头、四十 |
|
||||
| [01-tech-stack.md](./01-tech-stack.md) | 前端 / 后端 / 数据库 / Python 技术栈 | 一 ~ 四 |
|
||||
| [02-architecture.md](./02-architecture.md) | 总体架构、职责边界、Redis、避免过度设计 | 五、二十一、二十八 |
|
||||
| [03-multi-tenancy.md](./03-multi-tenancy.md) | SaaS 多租户、tenant_code、TenantContext | 六、七 |
|
||||
| [04-domain-model.md](./04-domain-model.md) | 业务编码、业务模块、订单模型、第三方平台、状态机 | 八、十二 ~ 十五 |
|
||||
| [05-inventory.md](./05-inventory.md) | 库存模型、库存流水、并发安全 | 九 ~ 十一 |
|
||||
| [06-backend-laravel.md](./06-backend-laravel.md) | Laravel 代码分层与目录结构 | 十六、后端框架结构 |
|
||||
| [07-api.md](./07-api.md) | API 路由规范与统一返回格式 | 十七、十八 |
|
||||
| [08-queue-scheduler.md](./08-queue-scheduler.md) | 队列与定时任务 | 十九、二十 |
|
||||
| [09-database.md](./09-database.md) | 数据库设计要求与规范 | 三、二十七 |
|
||||
| [10-frontend.md](./10-frontend.md) | 前端框架、目录、Element Plus、权限 | 一、二十三 ~ 二十五 |
|
||||
| [11-py-service.md](./11-py-service.md) | Python AI / Data Service(`py-service/`)边界与结构 | 四、二十二 |
|
||||
| [12-security-audit.md](./12-security-audit.md) | 日志审计与安全要求 | 二十六、三十五 |
|
||||
| [13-docker.md](./13-docker.md) | Docker 开发环境 | 二十九 |
|
||||
| [14-testing.md](./14-testing.md) | 测试要求 | 三十四 |
|
||||
| [15-development-workflow.md](./15-development-workflow.md) | 开发原则、代码质量、Cursor 工作方式、禁止事项 | 三十、三十六 ~ 三十九 |
|
||||
| [16-roadmap.md](./16-roadmap.md) | 设计先行、Phase 开发顺序、第一步任务 | 三十一 ~ 三十三、现在开始 |
|
||||
| [database/](./database/README.md) | 数据库表结构设计(按领域分文件) | — |
|
||||
|
||||
## 核心原则
|
||||
|
||||
**简单、清晰、可维护、可扩展、业务优先。**
|
||||
|
||||
- Laravel 是唯一的核心业务系统,MySQL 是业务事实数据源。
|
||||
- 所有核心业务数据按 `tenant_code` 隔离,由 TenantContext 统一处理。
|
||||
- 库存余额是结果,库存流水是事实;库存变更必须并发安全、可追溯。
|
||||
- Python 只做 AI / 数据分析,只通过 API 与 Laravel 交互。
|
||||
- 分阶段开发,每个 Phase 先说明方案、再实施、再验证。
|
||||
Reference in New Issue
Block a user