makemd/docs/README.md

# Crawlful Hub 文档结构

本文档描述了 Crawlful Hub 项目的文档组织结构，便于团队成员快速定位和理解各个文档的用途。

## 📁 目录结构

```
docs/
├─ 00_Business/                          # 业务层文档
│   ├─ Business_ClosedLoops.md          # 业务闭环文档（核心）
│   ├─ Business_Blueprint.md             # 业务蓝图
│   ├─ Business_Features.md              # 业务功能说明
│   ├─ Business_9.md                     # 业务9
│   ├─ Governance_Standards.md           # 治理标准
│   └─ Task_Overview.md                  # 任务概览
│
├─ 01_Architecture/                       # 架构层文档
│   ├─ System_Architecture.md            # 系统架构
│   ├─ Module_Blueprints.md              # 模块蓝图
│   ├─ Module_Responsibilities.md        # 模块职责（待创建）
│   ├─ AI_Agent_Interaction.md           # AI Agent 交互（待创建）
│   ├─ Data_Flow_Diagrams/               # 数据流图
│   └─ Sequence_Flow_Diagrams/           # 业务流程图
│
├─ 02_Backend/                            # 后端文档
│   ├─ Backend_Design.md                 # 后端设计（待创建）
│   ├─ API_Specs/                        # API 规范
│   │   ├─ Data_API_Specs.md             # 数据 API 规范
│   │   ├─ Product_API.md                # 商品 API（待创建）
│   │   ├─ Order_API.md                  # 订单 API（待创建）
│   │   └─ Finance_API.md                # 财务 API（待创建）
│   ├─ Database/                        # 数据库文档
│   │   ├─ ERD.md                        # 数据库设计图（待创建）
│   │   └─ Table_Definitions.md          # 表定义（待创建）
│   ├─ Services/                        # 服务模块说明（待创建）
│   └─ Backend_Automation.md             # 后端自动化（待创建）
│
├─ 03_Frontend/                           # 前端文档
│   ├─ Frontend_Design.md                # 前端设计（待创建）
│   ├─ UI_Components.md                  # UI 组件（待创建）
│   ├─ Pages_Flow.md                     # 页面流转（待创建）
│   ├─ API_Consumption.md                # API 调用（待创建）
│   └─ Frontend_Automation.md            # 前端自动化（待创建）
│
├─ 04_Plugin/                             # 插件文档
│   ├─ Plugin_Design.md                  # 插件设计（待创建）
│   ├─ DOM_Interaction.md                # DOM 交互（待创建）
│   ├─ Automation_Scripts.md             # 自动化脚本（待创建）
│   └─ Plugin_Agent_Integration.md       # 插件集成（待创建）
│
├─ 05_AI/                                 # AI 文档
│   ├─ AI_Strategy.md                    # AI 策略（待创建）
│   ├─ AI_Context.md                     # AI 上下文（待创建）
│   ├─ AI_Tasks.md                       # AI 任务（待创建）
│   ├─ AI_Training_Data/                 # AI 训练数据
│   └─ AI_Model_Integration.md           # AI 模型集成（待创建）
│
├─ 06_ETL/                                # ETL 文档
│   ├─ ETL_Pipelines.md                  # ETL 流程（待创建）
│   ├─ ETL_Scripts/                      # ETL 脚本
│   └─ ETL_Data_Samples/                 # ETL 样例数据
│
├─ 07_Testing/                            # 测试文档
│   ├─ Test_Strategy.md                  # 测试策略（待创建）
│   ├─ Quality_Optimization.md           # 质量优化
│   ├─ Unit_Tests/                       # 单元测试
│   ├─ Integration_Tests/                # 集成测试
│   └─ Test_Reports/                     # 测试报告
│
├─ 08_Deployment/                         # 部署文档
│   ├─ Deployment_Guide.md               # 部署指南（待创建）
│   ├─ CI_CD_Pipelines.md                # CI/CD 流程（待创建）
│   └─ Environment_Configs/              # 环境配置
│
├─ 09_Operations/                         # 运维文档
│   ├─ Monitoring.md                     # 监控（待创建）
│   ├─ Logging.md                        # 日志（待创建）
│   ├─ Exception_Handling.md             # 异常处理（待创建）
│   └─ Maintenance_Guide.md              # 维护指南（待创建）
│
├─ 10_Documents_Global/                   # 全局文档
│   ├─ PROJECT_MAP.md                    # 项目地图（待创建）
│   ├─ README.md                         # 项目总览（待创建）
│   ├─ Changelog.md                      # 变更日志（待创建）
│   └─ DOC_INDEX.md                      # 文档索引
│
└─ 11_References/                         # 参考资料
    ├─ Platform_API_Docs/                # 平台 API 文档
    ├─ Regulatory_Requirements.md       # 合规要求（待创建）
    └─ Glossary.md                       # 术语表（待创建）
```

## 📋 文档分类说明

### 00_Business/ - 业务层
包含所有业务相关的文档，是理解项目业务逻辑的核心。

**核心文档**：
- `Business_ClosedLoops.md` - 完整的业务闭环文档，涵盖 TOC/TOB 双向闭环
- `Business_Blueprint.md` - 业务蓝图，描述整体业务架构
- `Business_Features.md` - 详细的功能说明

### 01_Architecture/ - 架构层
描述系统的技术架构和模块设计。

**核心文档**：
- `System_Architecture.md` - 系统总体架构
- `Module_Blueprints.md` - 各模块的详细设计

### 02_Backend/ - 后端层
后端技术实现文档，包括 API、数据库、服务等。

**核心文档**：
- `API_Specs/` - 所有 API 的详细规范
- `Database/` - 数据库设计和表结构

### 03_Frontend/ - 前端层
前端技术实现文档，包括 UI 组件、页面流转等。

### 04_Plugin/ - 插件层
浏览器插件的设计和实现文档。

### 05_AI/ - AI 层
AI 相关的文档，包括策略、上下文、任务等。

### 06_ETL/ - ETL 层
数据采集、清洗、处理的流程和脚本。

### 07_Testing/ - 测试层
测试策略、用例、报告等文档。

### 08_Deployment/ - 部署层
部署指南、CI/CD 流程、环境配置等。

### 09_Operations/ - 运维层
监控、日志、异常处理、维护指南等。

### 10_Documents_Global/ - 全局文档
项目级别的文档，包括总览、索引、变更日志等。

### 11_References/ - 参考资料
外部参考文档，如平台 API、合规要求、术语表等。

## 🎯 快速导航

### 新人入门
1. 阅读 `00_Business/Business_ClosedLoops.md` 了解业务闭环
2. 阅读 `01_Architecture/System_Architecture.md` 了解系统架构
3. 阅读 `10_Documents_Global/DOC_INDEX.md` 查看文档索引

### 开发人员
1. 阅读 `01_Architecture/` 下的架构文档
2. 阅读 `02_Backend/` 或 `03_Frontend/` 下的技术文档
3. 参考 `11_References/` 下的平台 API 文档

### 测试人员
1. 阅读 `07_Testing/Test_Strategy.md` 了解测试策略
2. 查看 `07_Testing/` 下的测试文档

### 运维人员
1. 阅读 `08_Deployment/Deployment_Guide.md` 了解部署流程
2. 阅读 `09_Operations/` 下的运维文档

## 📝 文档规范

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

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

### 版本控制
- 所有文档纳入 Git 版本控制
- 重要变更记录在 `10_Documents_Global/Changelog.md`
- 遵循项目的 Git 工作流程

## 🔗 相关资源

- 项目根目录：`d:\trae_projects\makemd\makemd`
- 原文档目录：`d:\trae_projects\makemd\makemd\docs11`
- 项目规则：`d:\trae_projects\makemd\makemd\.trae\rules\project-specific-rules.md`

## 📞 联系方式

如有文档相关问题，请联系项目维护者。

---

**最后更新时间**：2026-03-17
**维护者**：Crawlful Hub 团队