wurenzhi/makemd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
427becbc8f24915a6dfe0d9dfe2dde873ad003df
makemd/docs/10_Documents_Global/DOC_INDEX.md
wurenzhi 427becbc8f refactor(types): 重构类型系统，统一共享类型定义 
feat(types): 新增共享类型中心，包含用户、产品、订单等核心领域类型
fix(types): 修复类型定义错误，统一各模块类型引用
style(types): 优化类型文件格式和注释
docs(types): 更新类型文档和变更日志
test(types): 添加类型测试用例
build(types): 配置类型共享路径
chore(types): 清理重复类型定义文件
2026-03-20 17:53:46 +08:00

193 lines
12 KiB
Markdown
Raw Blame History

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