- 移除extension模块,将功能迁移至node-agent - 修复类型导出问题,使用export type明确类型导出 - 统一数据库连接方式,从直接导入改为使用config/database - 更新文档中的项目结构描述 - 添加多个服务的实用方法,如getForecast、getBalances等 - 修复类型错误和TS1205警告 - 优化RedisService调用方式 - 添加新的实体类型定义 - 更新审计日志格式,统一字段命名
12 KiB
12 KiB
📚 Crawlful Hub Documentation Index
说明: 本文档索引帮助开发者快速定位项目文档。
核心任务表: Task_Overview.md (95个任务追踪)
1️⃣ 业务层 (00_Business)
业务战略、闭环流程、功能规格、行业标杆
| 文件 | 说明 |
|---|---|
| Business_ClosedLoops.md | 业务闭环文档(核心): 69个完整业务闭环流程,涵盖TOC/TOB双向闭环 |
| Business_Blueprint.md | 业务蓝图: 项目目标、技术栈、核心业务模块功能规格、行业标杆参考 |
| Governance_Standards.md | 治理标准: 开发规范、协作协议、任务规格、运维治理 |
| Task_Overview.md | 任务概览: 任务追踪,包含前后端、插件、AI、数据、运维模块 |
2️⃣ 架构层 (01_Architecture)
系统架构、模块蓝图、技术栈
| 文件 | 说明 |
|---|---|
| 00_Architecture_Index | 架构索引: 架构文档总览与导航 |
| 01_System | 系统架构: 后端、前端、插件架构设计及依赖规则 |
| 02_System_Interoperability | 系统互通架构: 系统各组件之间的互通机制和通信规范 |
| 03_Domain_Model | 领域模型: 核心领域对象和关系定义 |
| 04_Service_Map | 服务地图: 后端服务接口映射和依赖关系 |
| 05_Module_Blueprints | 模块蓝图: OMS, WMS, Finance, MKT等模块的前端集成蓝图 |
| 06_State_Machine | 状态机: 商户、用户、店铺、功能、订单、商品、库存、支付、账单、结算、任务状态机定义 |
| 07_SEMANTIC_HUB | 语义中心: 语义模型、语义解析、语义匹配 |
| 08_BILLING_RULES | 计费规则: 订阅计费、功能计费、API计费规则 |
| 09_PERMISSION_RULES | 权限规则: RBAC权限模型、角色定义、权限校验规则 |
| 10_Currency_Management | 货币管理: 多货币支持、汇率管理、货币转换 |
| 11_Mock_Architecture | Mock架构: 低侵入Mock方案,支持DataSource内联和MSW网络层两种方式 |
| 12_Operation_Agent | 运营Agent: 运营自动化、Agent设计、任务调度 |
| 13_TypeScript_Standards | TypeScript编译规约: TypeScript编译零错误规约体系、tsconfig配置、代码规约 |
| 14_Code_Quality_Standards | 代码质量规范: ESLint配置、Prettier配置、代码风格规范、测试规范 |
| 15_Schema_Driven_Development | Schema驱动开发: zod使用指南、Schema组织、类型推导、数据验证 |
| 16_Unified_Type_Management | 统一类型管理: 类型中心架构、类型层次、类型转换、版本管理 |
| frontend/01_Product | 产品前端: 产品模块前端设计规范 |
| frontend/02_Orders | 订单前端: 订单模块前端设计规范 |
| frontend/03_Ad | 广告前端: 广告模块前端设计规范 |
| frontend/04_IndependentSite | 独立站点前端: 独立站点模块前端设计规范 |
3️⃣ 后端文档 (02_Backend)
API规范、数据库设计、服务模块
| 文件 | 说明 |
|---|---|
| 00_Backend_Index | 后端索引: 后端文档总览与导航 |
| 01_Design | 后端设计: 后端架构设计、技术栈、模块划分 |
| 02_Service_Design | 服务设计: 核心服务设计、接口定义、业务逻辑 |
| 03_Event_Driven | 事件驱动: 事件总线、事件发布订阅、异步处理 |
| 04_Config_Driven | 配置驱动: 配置管理、动态配置、配置热更新 |
| 05_Data_Consistency | 数据一致性: 分布式事务、最终一致性、数据同步 |
| 06_Observability | 可观测性: 日志、监控、追踪、告警 |
| 07_RBAC_Design | RBAC设计: 基于角色的访问控制设计 |
| api/00_API_Index | API索引: API规范总览 |
| api/01_Data_API | 数据API规范: 数据库Schema、核心业务流程图及API映射 |
| api/02_Finance_API | 财务API: 财务相关API规范 |
| api/03_Order_API | 订单API: 订单相关API规范 |
| api/04_Product_API | 商品API: 商品相关API规范 |
4️⃣ 前端文档 (03_Frontend)
前端设计、UI组件、页面流转
| 文件 | 说明 |
|---|---|
| 00_Frontend_Index | 前端索引: 前端文档总览与导航 |
| 01_Design | 前端设计: 前端架构、设计原则、技术选型 |
| 02_Development_Guide | 前端开发指南: 前端开发规范、技术栈、项目结构 |
| 03_Optimization_Guide | 前端优化指南: 性能优化、代码优化、构建优化 |
| 04_Interaction_Guidelines | 交互指南: 交互设计、用户体验、交互规范 |
| 05_UI_Components | UI组件: 组件库、组件规范、组件使用 |
| 06_Pages_Flow | 页面流转: 页面路由、页面跳转、状态管理 |
5️⃣ 插件文档 (04_Plugin)
插件设计、DOM交互、自动化脚本
| 文件 | 说明 |
|---|---|
| 00_Plugin_Index | 插件索引: 插件文档总览与导航 |
| 01_Plugin_Design | 插件设计: 插件架构、插件生命周期、插件通信 |
| 02_DOM_Interaction | DOM交互: DOM操作、事件监听、页面注入 |
6️⃣ AI文档 (05_AI)
AI策略、上下文、任务、模型集成
| 文件 | 说明 |
|---|---|
| 00_AI_Index | AI索引: AI文档总览与导航 |
| 01_Strategy | AI策略: AI协作策略、节点自动决策体系、规则引擎 |
| 02_Rules | AI规则: AI开发规则、代码规范、上下文管理 |
| 03_Implementation_Strategy | AI实施策略: AI实施策略和落地计划 |
| 04_Quick_Reference_Card | AI快速参考卡片: 硬性约束、代码模板、常见错误对比 |
| 05_Development_Checklist | AI开发检查清单: 开发各阶段强制检查项 |
| 06_Wrong_vs_Right_Examples | 错误示例对比: 错误代码模式与正确实现方式 |
| 07_TypeScript_Error_Fix_Guide | TypeScript错误修复方案: 解决613个编译错误的完整方案 |
| 09_TypeScript_Error_Tasks | TypeScript错误任务列表: AI领取修复任务的清单 |
7️⃣ 测试文档 (07_Testing)
测试策略、质量优化
| 文件 | 说明 |
|---|---|
| 00_Testing_Index | 测试索引: 测试文档总览与导航 |
| 01_Test_Spec | 测试规范: 测试策略、测试类型、测试流程 |
| 02_Quality_Optimization | 质量优化: 交付标准、体验检查、文档报告 |
8️⃣ 报告文档 (06_Reports)
项目报告、进度跟踪、代码审查
| 文件 | 说明 |
|---|---|
| 00_Reports_Index | 报告索引: 报告文档总览与导航 |
| 01_Business_ClosedLoop | 业务闭环报告: 业务功能闭环分析报告 |
| 02_Code_Review | 代码审查报告: 代码质量审查报告 |
| 03_Development_Progress | 开发进度报告: 项目开发进度跟踪 |
| 04_Temporary | 临时建议: 临时修改建议与方案 |
9️⃣ 分析文档 (08_Analysis)
系统分析、数据流、异常处理
| 文件 | 说明 |
|---|---|
| 00_Analysis_Index | 分析索引: 分析文档总览与导航 |
| 01_Business_Service_Mapping | 业务服务映射: 业务功能与服务映射关系 |
| 02_Data_Flow | 数据流分析: 系统数据流分析 |
| 03_Exception_Handling | 异常处理分析: 异常处理机制分析 |
| 04_Frontend_Business_Mapping | 前端业务映射: 前端页面与业务功能映射 |
| 05_Service_State_Mapping | 服务状态映射: 服务与状态机映射关系 |
| 06_Runtime_Architecture | 运行时架构: 运行时架构分析 |
🔟 全局文档 (10_Documents_Global)
项目地图、文档索引、术语标准
| 文件 | 说明 |
|---|---|
| README.md | 文档结构说明: 完整目录结构及文档分类说明 |
| PROJECT_MAP.md | 项目地图: 模块依赖关系及文档结构图 |
| DOC_INDEX.md | 文档索引: 本文档,快速定位所有文档 |
| TERMINOLOGY_STANDARDS.md | 术语标准: 项目术语标准化规范,确保跨文档语义一致性 |
📊 文档完成度
| 模块 | 文档数 | 状态 |
|---|---|---|
| 00_Business | 5 | ✅ |
| 00_Business/tasks/frontend | 12 | ✅ |
| 00_Business/tasks/backend | 24 | ✅ |
| 00_Business/tasks/shared | 13 | ✅ |
| 01_Architecture | 16 | ✅ |
| 02_Backend | 12 | ✅ |
| 03_Frontend | 7 | ✅ |
| 04_Plugin | 3 | ✅ |
| 05_AI | 9 | ✅ |
| 06_Reports | 5 | ✅ |
| 07_Testing | 3 | ✅ |
| 08_Analysis | 7 | ✅ |
| 10_Documents_Global | 3 | ✅ |
| 总计 | 123 | ✅ |
🔗 相关资源
- 项目规则:
.trae/rules/project-specific-rules.md- 硬性约束和配置 - 代码库:
server/src/,dashboard/src/,node-agent/src/
最后更新: 2026-03-20