makemd/docs/README.md

Crawlful Hub 文档中心

定位：Crawlful Hub 项目完整文档库 - 涵盖业务、架构、技术实现及运维指南。 最后更新：2026-03-18

---

📊 项目状态看板

模块	完成度	状态
业务层	100%	✅ 完成
架构层	100%	✅ 完成
后端	45%	🟡 进行中
前端	0%	🔴 待开始
插件	0%	🔴 待开始
AI	13%	🟡 进行中
文档	65%	🟡 进行中

任务统计：126个任务 | 27已完成 | 4进行中 | 95待处理 | 完成率21%

---

📁 文档目录

核心文档（必读）

文档	路径	说明
📋 业务闭环	00_Business/Business_ClosedLoops.md	30个完整业务闭环流程
🏗️ 业务蓝图	00_Business/Business_Blueprint.md	功能规格与行业标杆
📋 任务总览	00_Business/Task_Overview.md	103个任务追踪（唯一任务源）
🏛️ 系统架构	01_Architecture/System_Architecture.md	系统总体架构设计
📐 模块蓝图	01_Architecture/Module_Blueprints.md	各模块详细设计

技术文档

模块	关键文档	状态
后端	Backend_Design.md	✅ 已创建
	Product_API.md	✅ 已创建
	Order_API.md	✅ 已创建
	Finance_API.md	✅ 已创建
前端	Frontend_Design.md	✅ 已创建
	UI_Components.md	✅ 已创建
	Pages_Flow.md	✅ 已创建
插件	Plugin_Design.md	✅ 已创建
	DOM_Interaction.md	✅ 已创建
AI	AI_Strategy.md	✅ 已创建

索引文档

• 📑 文档索引 - 所有文档的完整索引
• 🗺️ 项目地图 - 项目结构导航

---

🚀 快速开始

新人入门

1. 了解业务：阅读 Business_ClosedLoops.md 了解35个业务闭环
2. 理解架构：阅读 System_Architecture.md 了解系统架构
3. 查看任务：阅读 Task_Overview.md 了解当前任务状态
4. 熟悉规范：阅读 Governance_Standards.md 了解开发规范

开发人员

角色	必读文档
后端开发	Backend_Design.md + API_Specs
前端开发	Frontend_Design.md + UI_Components.md
插件开发	Plugin_Design.md + DOM_Interaction.md
AI开发	AI_Strategy.md + Task_Overview.md

---

📋 文档规范

命名规范

• 文件名使用大驼峰命名法（PascalCase）
• 文件扩展名为 .md
• 避免使用特殊字符和空格

内容规范

• 使用 Markdown 格式
• 包含清晰的标题层级
• 适当使用表格、代码块、流程图等
• 标注文档最后更新时间

优先级标注

• 最高优先级参考：Business_ClosedLoops.md - 所有技术实现必须基于业务闭环
• 冲突情况下，优先保留业务闭环文档的内容

---

🔗 相关资源

• 项目根目录：d:\trae_projects\makemd\makemd
• 项目规则：.trae/rules/project-specific-rules.md
• 后端代码：server/src/
• 前端代码：web/src/（待创建）
• 插件代码：extension/src/（待创建）

---

📝 更新日志

日期	更新内容
2026-03-18	完善后端文档（Backend_Design + API Specs）
2026-03-18	创建前端文档（Frontend_Design + UI_Components + Pages_Flow）
2026-03-18	创建插件文档（Plugin_Design + DOM_Interaction）
2026-03-18	创建AI策略文档（AI_Strategy）
2026-03-18	更新 Task_Overview.md 添加多商户任务
2026-03-18	优化 README.md 结构和内容

---

维护者：Crawlful Hub 团队