wurenzhi
aa2cf560c6
refactor: 重构数据源工厂和类型定义，提升代码可维护性 fix: 修复类型转换和状态机文档中的错误 docs: 更新服务架构文档，添加新的服务闭环流程 test: 添加汇率服务单元测试 chore: 清理无用代码和注释，优化代码结构
7.3 KiB
7.3 KiB
📚 Crawlful Hub Documentation Index
说明: 本文档索引帮助开发者快速定位项目文档。 核心任务表: Task_Overview.md (95个任务追踪)
1️⃣ 业务层 (00_Business)
业务战略、闭环流程、功能规格、行业标杆
| 文件 | 说明 |
|---|---|
| Business_ClosedLoops.md | 业务闭环文档（核心）: 58个完整业务闭环流程，涵盖TOC/TOB双向闭环 |
| Business_Blueprint.md | 业务蓝图: 项目目标、技术栈、核心业务模块功能规格、行业标杆参考 |
| Governance_Standards.md | 治理标准: 开发规范、协作协议、任务规格、运维治理 |
| Task_Overview.md | 任务概览: 任务追踪，包含前后端、插件、AI、数据、运维模块 |
2️⃣ 架构层 (01_Architecture)
系统架构、模块蓝图、技术栈
| 文件 | 说明 |
|---|---|
| System_Architecture.md | 系统架构: 后端、前端、插件架构设计及依赖规则 |
| Runtime_Architecture.md | 运行时架构: 插件运行时、沙箱隔离、消息传递机制 |
| Module_Blueprints.md | 模块蓝图: OMS, WMS, Finance, MKT等模块的前端集成蓝图 |
| SERVICE_MAP.md | 服务地图: 后端服务接口映射和依赖关系 |
| STATE_MACHINE.md | 状态机: 商户、用户、店铺、功能、订单、商品、库存、支付、账单、结算、任务状态机定义 |
| Mock_Architecture.md | Mock架构: 低侵入Mock方案，支持DataSource内联和MSW网络层两种方式 |
| BILLING_RULES.md | 计费规则: 订阅计费、功能计费、API计费规则 |
| PERMISSION_RULES.md | 权限规则: RBAC权限模型、角色定义、权限校验规则 |
| DOMAIN_MODEL.md | 领域模型: 核心领域对象和关系定义 |
| frontend/Product.front.md | 产品前端: 产品模块前端设计规范 |
| frontend/Orders.front.md | 订单前端: 订单模块前端设计规范 |
| frontend/Ad.front.md | 广告前端: 广告模块前端设计规范 |
| frontend/IndependentSite.front.md | 独立站点前端: 独立站点模块前端设计规范 |
3️⃣ 后端文档 (02_Backend)
API规范、数据库设计、服务模块
| 文件 | 说明 |
|---|---|
| Backend_Design.md | 后端设计: 后端架构设计、技术栈、模块划分 |
| Service_Design.md | 服务设计: 核心服务设计、接口定义、业务逻辑 |
| Event_Driven.md | 事件驱动: 事件总线、事件发布订阅、异步处理 |
| Config_Driven.md | 配置驱动: 配置管理、动态配置、配置热更新 |
| RBAC_Design.md | RBAC设计: 基于角色的访问控制设计 |
| Observability.md | 可观测性: 日志、监控、追踪、告警 |
| Data_Consistency.md | 数据一致性: 分布式事务、最终一致性、数据同步 |
| API_Specs/Data_API_Specs.md | 数据API规范: 数据库Schema、核心业务流程图及API映射 |
| API_Specs/Product_API.md | 商品API: 商品相关API规范 |
| API_Specs/Order_API.md | 订单API: 订单相关API规范 |
| API_Specs/Finance_API.md | 财务API: 财务相关API规范 |
4️⃣ 前端文档 (03_Frontend)
前端设计、UI组件、页面流转
| 文件 | 说明 |
|---|---|
| Frontend_Development_Guide.md | 前端开发指南: 前端开发规范、技术栈、项目结构 |
| Frontend_Design.md | 前端设计: 前端架构、设计原则、技术选型 |
| Frontend_Optimization_Guide.md | 前端优化指南: 性能优化、代码优化、构建优化 |
| UI_Components.md | UI组件: 组件库、组件规范、组件使用 |
| Pages_Flow.md | 页面流转: 页面路由、页面跳转、状态管理 |
| Interaction_Guidelines.md | 交互指南: 交互设计、用户体验、交互规范 |
5️⃣ 插件文档 (04_Plugin)
插件设计、DOM交互、自动化脚本
| 文件 | 说明 |
|---|---|
| Plugin_Design.md | 插件设计: 插件架构、插件生命周期、插件通信 |
| DOM_Interaction.md | DOM交互: DOM操作、事件监听、页面注入 |
6️⃣ AI文档 (05_AI)
AI策略、上下文、任务、模型集成
| 文件 | 说明 |
|---|---|
| AI_Strategy.md | AI策略: AI协作策略、节点自动决策体系、规则引擎 |
| AI_RULES.md | AI规则: AI开发规则、代码规范、上下文管理 |
| AI_Module_List.md | AI模块列表: AI功能模块、模块接口、模块依赖 |
7️⃣ 测试文档 (07_Testing)
测试策略、质量优化
| 文件 | 说明 |
|---|---|
| TEST_SPEC.md | 测试规范: 测试策略、测试类型、测试流程 |
| Quality_Optimization.md | 质量优化: 交付标准、体验检查、文档报告 |
8️⃣ 全局文档 (10_Documents_Global)
项目地图、文档索引
| 文件 | 说明 |
|---|---|
| README.md | 文档结构说明: 完整目录结构及文档分类说明 |
| PROJECT_MAP.md | 项目地图: 模块依赖关系及文档结构图 |
| DOC_INDEX.md | 文档索引: 本文档，快速定位所有文档 |
📊 文档完成度
| 模块 | 已存在 | 完成率 |
|---|---|---|
| 00_Business | 4 | 100% ✅ |
| 01_Architecture | 12 | 100% ✅ |
| 02_Backend | 11 | 100% ✅ |
| 03_Frontend | 6 | 100% ✅ |
| 04_Plugin | 2 | 100% ✅ |
| 05_AI | 3 | 100% ✅ |
| 07_Testing | 2 | 100% ✅ |
| 10_Documents_Global | 3 | 100% ✅ |
| 总计 | 43 | 100% ✅ |
🔗 相关资源
- 项目规则:
.trae/rules/project-specific-rules.md- 硬性约束和配置 - 代码库:
server/src/,console/src/,extension/src/
最后更新: 2026-03-19