wurenzhi/makemd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: 清理归档文件和文档模板

Browse Source 
删除不再需要的归档文件和过时的文档模板，包括多个README、安全策略、前端集成蓝图等文件，同时移除了未使用的业务文档和项目结构文件。

优化项目结构，移除冗余文件，保持代码库整洁。主要删除archive/handover目录下的多个文件及doc目录下的部分文档模板。
This commit is contained in:
wurenzhi
2026-03-18 01:21:15 +08:00
parent 56b8a2e2f8
commit 72cd7f6f45
147 changed files with 5982 additions and 16716 deletions
Download Patch File Download Diff File Expand all files Collapse all files

241
docs/README.md
View File

@@ -1,167 +1,81 @@
# Crawlful Hub 文档结构
# Crawlful Hub 文档中心
本文档描述了 Crawlful Hub 项目的文档组织结构，便于团队成员快速定位和理解各个文档的用途。
> **定位**：Crawlful Hub 项目完整文档库 - 涵盖业务、架构、技术实现及运维指南。
> **最后更新**：2026-03-18
## 📁 目录结构
---
```
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 # 术语表（待创建）
```
## 📊 项目状态看板
## 📋 文档分类说明
| 模块 | 完成度 | 状态 |
|------|--------|------|
| 业务层 | 100% | ✅ 完成 |
| 架构层 | 100% | ✅ 完成 |
| 后端 | 45% | 🟡 进行中 |
| 前端 | 0% | 🔴 待开始 |
| 插件 | 0% | 🔴 待开始 |
| AI | 13% | 🟡 进行中 |
| 文档 | 65% | 🟡 进行中 |
### 00_Business/ - 业务层
包含所有业务相关的文档，是理解项目业务逻辑的核心。
**任务统计**：126个任务 | 27已完成 | 4进行中 | 95待处理 | 完成率21%
**核心文档**：
- `Business_ClosedLoops.md` - 完整的业务闭环文档，涵盖 TOC/TOB 双向闭环
- `Business_Blueprint.md` - 业务蓝图，描述整体业务架构
- `Business_Features.md` - 详细的功能说明
---
### 01_Architecture/ - 架构层
描述系统的技术架构和模块设计。
## 📁 文档目录
**核心文档**：
- `System_Architecture.md` - 系统总体架构
- `Module_Blueprints.md` - 各模块的详细设计
### 核心文档（必读）
### 02_Backend/ - 后端层
后端技术实现文档，包括 API、数据库、服务等。
| 文档 | 路径 | 说明 |
|------|------|------|
| 📋 业务闭环 | [00_Business/Business_ClosedLoops.md](./00_Business/Business_ClosedLoops.md) | 30个完整业务闭环流程 |
| 🏗️ 业务蓝图 | [00_Business/Business_Blueprint.md](./00_Business/Business_Blueprint.md) | 功能规格与行业标杆 |
| 📋 任务总览 | [00_Business/Task_Overview.md](./00_Business/Task_Overview.md) | 103个任务追踪（唯一任务源） |
| 🏛️ 系统架构 | [01_Architecture/System_Architecture.md](./01_Architecture/System_Architecture.md) | 系统总体架构设计 |
| 📐 模块蓝图 | [01_Architecture/Module_Blueprints.md](./01_Architecture/Module_Blueprints.md) | 各模块详细设计 |
**核心文档**：
- `API_Specs/` - 所有 API 的详细规范
- `Database/` - 数据库设计和表结构
### 技术文档
### 03_Frontend/ - 前端层
前端技术实现文档，包括 UI 组件、页面流转等。
| 模块 | 关键文档 | 状态 |
|------|----------|------|
| **后端** | [Backend_Design.md](./02_Backend/Backend_Design.md) | ✅ 已创建 |
| | [Product_API.md](./02_Backend/API_Specs/Product_API.md) | ✅ 已创建 |
| | [Order_API.md](./02_Backend/API_Specs/Order_API.md) | ✅ 已创建 |
| | [Finance_API.md](./02_Backend/API_Specs/Finance_API.md) | ✅ 已创建 |
| **前端** | [Frontend_Design.md](./03_Frontend/Frontend_Design.md) | ✅ 已创建 |
| | [UI_Components.md](./03_Frontend/UI_Components.md) | ✅ 已创建 |
| | [Pages_Flow.md](./03_Frontend/Pages_Flow.md) | ✅ 已创建 |
| **插件** | [Plugin_Design.md](./04_Plugin/Plugin_Design.md) | ✅ 已创建 |
| | [DOM_Interaction.md](./04_Plugin/DOM_Interaction.md) | ✅ 已创建 |
| **AI** | [AI_Strategy.md](./05_AI/AI_Strategy.md) | ✅ 已创建 |
### 04_Plugin/ - 插件层
浏览器插件的设计和实现文档。
### 索引文档
### 05_AI/ - AI 层
AI 相关的文档，包括策略、上下文、任务等。
- [📑 文档索引](./10_Documents_Global/DOC_INDEX.md) - 所有文档的完整索引
- [🗺️ 项目地图](./10_Documents_Global/PROJECT_MAP.md) - 项目结构导航
### 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. **了解业务**：阅读 [Business_ClosedLoops.md](./00_Business/Business_ClosedLoops.md) 了解35个业务闭环
2. **理解架构**：阅读 [System_Architecture.md](./01_Architecture/System_Architecture.md) 了解系统架构
3. **查看任务**：阅读 [Task_Overview.md](./00_Business/Task_Overview.md) 了解当前任务状态
4. **熟悉规范**：阅读 [Governance_Standards.md](./00_Business/Governance_Standards.md) 了解开发规范
### 开发人员
1. 阅读 `01_Architecture/` 下的架构文档
2. 阅读 `02_Backend/` 或 `03_Frontend/` 下的技术文档
3. 参考 `11_References/` 下的平台 API 文档
### 测试人员
1. 阅读 `07_Testing/Test_Strategy.md` 了解测试策略
2. 查看 `07_Testing/` 下的测试文档
| 角色 | 必读文档 |
|------|----------|
| **后端开发** | [Backend_Design.md](./02_Backend/Backend_Design.md) + [API_Specs](./02_Backend/API_Specs/) |
| **前端开发** | [Frontend_Design.md](./03_Frontend/Frontend_Design.md) + [UI_Components.md](./03_Frontend/UI_Components.md) |
| **插件开发** | [Plugin_Design.md](./04_Plugin/Plugin_Design.md) + [DOM_Interaction.md](./04_Plugin/DOM_Interaction.md) |
| **AI开发** | [AI_Strategy.md](./05_AI/AI_Strategy.md) + [Task_Overview.md](./00_Business/Task_Overview.md) |
### 运维人员
1. 阅读 `08_Deployment/Deployment_Guide.md` 了解部署流程
2. 阅读 `09_Operations/` 下的运维文档
---
## 📝 文档规范
## 📋 文档规范
### 命名规范
- 文件名使用大驼峰命名法（PascalCase）
@@ -174,22 +88,33 @@ AI 相关的文档，包括策略、上下文、任务等。
- 适当使用表格、代码块、流程图等
- 标注文档最后更新时间
### 版本控制
- 所有文档纳入 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`
## 📞 联系方式
如有文档相关问题，请联系项目维护者。
### 优先级标注
- **最高优先级参考**：`Business_ClosedLoops.md` - 所有技术实现必须基于业务闭环
- 冲突情况下，优先保留业务闭环文档的内容
---
**最后更新时间**：2026-03-17
**维护者**：Crawlful Hub 团队
## 🔗 相关资源
- **项目根目录**：`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 团队