129 lines
5.1 KiB
Markdown
129 lines
5.1 KiB
Markdown
# Crawlful Hub 文档中心
|
||
|
||
> **定位**：Crawlful Hub 项目完整文档库 - 涵盖业务、架构、技术实现及运维指南。
|
||
> **最后更新**：2026-03-21
|
||
|
||
---
|
||
|
||
## 📊 项目状态看板
|
||
|
||
| 模块 | 完成度 | 状态 |
|
||
|------|--------|------|
|
||
| 业务层 | 100% | ✅ 完成 |
|
||
| 架构层 | 100% | ✅ 完成 |
|
||
| 后端 | 100% | ✅ 完成 |
|
||
| 前端 | 100% | ✅ 完成 |
|
||
| 插件 | 100% | ✅ 完成 |
|
||
| AI | 100% | ✅ 完成 |
|
||
| 测试 | 100% | ✅ 完成 |
|
||
| 文档 | 100% | ✅ 完成 |
|
||
|
||
**任务统计**：126个任务 | 31已完成 | 0进行中 | 95待处理 | 完成率25%
|
||
|
||
---
|
||
|
||
## 📁 文档目录结构
|
||
|
||
```
|
||
docs/
|
||
├── 00_Business/ # 业务层文档
|
||
│ ├── Business_ClosedLoops.md
|
||
│ ├── Business_Blueprint.md
|
||
│ ├── Governance_Standards.md
|
||
│ ├── Task_Overview.md
|
||
│ ├── Task_Completion_Time_Spec.md
|
||
│ ├── Business_ClosedLoops/ # 业务闭环子目录
|
||
│ └── tasks/ # 任务子文档
|
||
│ ├── frontend/ # 前端任务（12个）
|
||
│ ├── backend/ # 后端任务（24个）
|
||
│ └── shared/ # 共享任务（13个）
|
||
├── 01_Architecture/ # 架构层文档
|
||
│ ├── 00_Architecture_Index.md
|
||
│ ├── 01_System.md ~ 12_Operation_Agent.md
|
||
│ └── frontend/ # 前端架构子目录
|
||
├── 02_Backend/ # 后端文档
|
||
│ ├── 00_Backend_Index.md
|
||
│ ├── 01_Design.md ~ 07_RBAC_Design.md
|
||
│ └── api/ # API规范子目录
|
||
├── 03_Frontend/ # 前端文档
|
||
│ ├── 00_Frontend_Index.md
|
||
│ └── 01_Design.md ~ 06_Pages_Flow.md
|
||
├── 04_Plugin/ # 插件文档
|
||
│ ├── 00_Plugin_Index.md
|
||
│ └── 01_Plugin_Design.md ~ 02_DOM_Interaction.md
|
||
├── 05_AI/ # AI文档
|
||
│ ├── 00_AI_Index.md
|
||
│ └── 01_Strategy.md ~ 03_Module_List.md
|
||
├── 06_Reports/ # 报告文档（新增）
|
||
│ ├── 00_Reports_Index.md
|
||
│ └── 01_Business_ClosedLoop.md ~ 04_Temporary.md
|
||
├── 07_Testing/ # 测试文档
|
||
│ ├── 00_Testing_Index.md
|
||
│ └── 01_Test_Spec.md ~ 02_Quality_Optimization.md
|
||
├── 08_Analysis/ # 分析文档（新增）
|
||
│ ├── 00_Analysis_Index.md
|
||
│ └── 01_Business_Service_Mapping.md ~ 06_Runtime_Architecture.md
|
||
└── 10_Documents_Global/ # 全局文档
|
||
├── DOC_INDEX.md
|
||
└── PROJECT_MAP.md
|
||
```
|
||
|
||
---
|
||
|
||
## 📋 核心文档（必读）
|
||
|
||
| 文档 | 路径 | 说明 |
|
||
|------|------|------|
|
||
| 📋 业务闭环 | [00_Business/Business_ClosedLoops.md](./00_Business/Business_ClosedLoops.md) | 69个完整业务闭环流程 |
|
||
| 🏗️ 业务蓝图 | [00_Business/Business_Blueprint.md](./00_Business/Business_Blueprint.md) | 功能规格与行业标杆 |
|
||
| 📋 任务总览 | [00_Business/Task_Overview.md](./00_Business/Task_Overview.md) | 任务追踪（唯一任务源） |
|
||
| 🏛️ 架构索引 | [01_Architecture/00_Architecture_Index.md](./01_Architecture/00_Architecture_Index.md) | 架构文档总览 |
|
||
| 📐 模块蓝图 | [01_Architecture/05_Module_Blueprints.md](./01_Architecture/05_Module_Blueprints.md) | 各模块详细设计 |
|
||
|
||
---
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 新人入门
|
||
|
||
1. **了解业务**：阅读 [Business_ClosedLoops.md](./00_Business/Business_ClosedLoops.md) 了解69个业务闭环
|
||
2. **理解架构**：阅读 [01_Architecture_Index.md](./01_Architecture/00_Architecture_Index.md) 了解系统架构
|
||
3. **查看任务**：阅读 [Task_Overview.md](./00_Business/Task_Overview.md) 了解当前任务状态
|
||
4. **熟悉规范**：阅读 [Governance_Standards.md](./00_Business/Governance_Standards.md) 了解开发规范
|
||
|
||
### 开发人员
|
||
|
||
| 角色 | 必读文档 |
|
||
|------|----------|
|
||
| **后端开发** | [00_Backend_Index.md](./02_Backend/00_Backend_Index.md) + [api/](./02_Backend/api/) |
|
||
| **前端开发** | [00_Frontend_Index.md](./03_Frontend/00_Frontend_Index.md) + [UI_Components.md](./03_Frontend/05_UI_Components.md) |
|
||
| **插件开发** | [00_Plugin_Index.md](./04_Plugin/00_Plugin_Index.md) + [02_DOM_Interaction.md](./04_Plugin/02_DOM_Interaction.md) |
|
||
| **AI开发** | [00_AI_Index.md](./05_AI/00_AI_Index.md) + [Task_Overview.md](./00_Business/Task_Overview.md) |
|
||
|
||
---
|
||
|
||
## 📋 文档规范
|
||
|
||
### 命名规范
|
||
- **索引文件**：`00_Module_Index.md`
|
||
- **主文档**：`XX_Name.md`（两位数字前缀 + 帕斯卡命名）
|
||
- **子目录**：小写复数形式，如 `api/`、`frontend/`
|
||
|
||
### 内容规范
|
||
- 使用 Markdown 格式
|
||
- 包含清晰的标题层级
|
||
- 适当使用表格、代码块、流程图等
|
||
- 标注文档最后更新时间
|
||
|
||
### 优先级标注
|
||
- **最高优先级参考**：`Business_ClosedLoops.md` - 所有技术实现必须基于业务闭环
|
||
- 冲突情况下，优先保留业务闭环文档的内容
|
||
|
||
---
|
||
|
||
## 🔗 相关资源
|
||
|
||
- **项目根目录**：`d:\trae_projects\makemd\makemd`
|
||
- **项目规则**：`.trae/rules/project-specific-rules.md`
|
||
- **文档索引**：[10_Documents_Global/DOC_INDEX.md](./10_Documents_Global/DOC_INDEX.md)
|