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

docs: 新增业务闭环文档并重构文档结构

Browse Source 
新增业务闭环文档，包含商品主数据、SKU变体、订单拆分等关键闭环
重构文档目录结构，迁移旧文档至新路径
补充业务功能说明文档内容
更新全局文档索引和项目地图
This commit is contained in:
wurenzhi
2026-03-18 00:35:00 +08:00
parent bdf6f6036d
commit 56b8a2e2f8
18 changed files with 4580 additions and 624 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/10_Documents_Global/DOC_INDEX.md Normal file
View File

@@ -0,0 +1,56 @@
# 📚 Crawlful Hub Documentation Index
> **说明**: 本文件是项目的深度索引，将全量文档聚合为核心蓝图与规格书，帮助开发者快速定位。
> **核心任务表**: [Crawlful_Hub_Task_Overview_Full_v1.md](Crawlful_Hub_Task_Overview_Full_v1.md) (唯一业务到模块任务表)
---
## 1️⃣ 业务核心 (01-business-core)
> 业务战略、功能蓝图、行业标杆
| 文件 | 说明 |
|------|------|
| [business-blueprint.md](01-business-core/business-blueprint.md) | **核心蓝图**: 包含项目目标、业务闭环、模块功能及标杆参考 (Merged) |
| [业务功能.md](业务功能.md) | **功能详述**: 聚合了订单、库存、财务、调价、广告等全量业务操作细节 (Updated) |
---
## 2️⃣ 数据与 API (02-data-api)
> 数据 Schema、业务流程、接口规格
| 文件 | 说明 |
|------|------|
| [data-api-specs.md](02-data-api/data-api-specs.md) | **数据接口规格**: 包含数据库 Schema、核心业务流程图及全量 API 映射 (Merged) |
---
## 3️⃣ 架构与技术 (03-architecture-tech)
> 系统架构、模块蓝图、技术栈
| 文件 | 说明 |
|------|------|
| [system-architecture.md](03-architecture-tech/system-architecture.md) | **系统架构**: 包含后端、前端、插件架构设计及依赖规则 (Merged) |
| [module-blueprints.md](03-architecture-tech/module-blueprints.md) | **功能蓝图**: 包含 OMS, WMS, Finance, MKT 等模块的前端集成蓝图 (Merged) |
---
## 4️⃣ 规范与治理 (04-standards-governance)
> 开发标准、协作协议、运维治理
| 文件 | 说明 |
|------|------|
| [governance-standards.md](04-standards-governance/governance-standards.md) | **治理规范**: 包含开发标准、JSDoc 规范、协作协议及风险治理 (Refactored) |
---
## 5️⃣ 质量与优化 (05-quality-optimization)
> 交付标准、体验检查、文档报告
| 文件 | 说明 |
|------|------|
| [quality-optimization.md](05-quality-optimization/quality-optimization.md) | **质量标准**: 包含前端交付质量标准、UX 检查清单及文档优化报告 (Merged) |
---
### 📂 归档 (Archive)
- [archive/](archive/) - 历史方案、旧版任务记录

192
docs/10_Documents_Global/PROJECT_MAP.md Normal file
View File

@@ -0,0 +1,192 @@
# Crawlful Hub 文档结构图
## 完整目录树
```
Crawlful_Hub/
│
├─ 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 (业务层)
↓
01_Architecture (架构层)
↓
02_Backend (后端层) + 03_Frontend (前端层) + 04_Plugin (插件层)
↓
05_AI (AI 层) + 06_ETL (ETL 层)
↓
07_Testing (测试层) + 08_Deployment (部署层) + 09_Operations (运维层)
↓
10_Documents_Global (全局文档) + 11_References (参考资料)
```
## 文档状态说明
### 已创建文档
- ✅ 00_Business/Business_ClosedLoops.md
- ✅ 00_Business/Business_Blueprint.md
- ✅ 00_Business/Business_Features.md
- ✅ 00_Business/Business_9.md
- ✅ 00_Business/Governance_Standards.md
- ✅ 00_Business/Task_Overview.md
- ✅ 01_Architecture/System_Architecture.md
- ✅ 01_Architecture/Module_Blueprints.md
- ✅ 02_Backend/API_Specs/Data_API_Specs.md
- ✅ 07_Testing/Quality_Optimization.md
- ✅ 10_Documents_Global/DOC_INDEX.md
### 待创建文档
- ❌ 01_Architecture/Module_Responsibilities.md
- ❌ 01_Architecture/AI_Agent_Interaction.md
- ❌ 02_Backend/Backend_Design.md
- ❌ 02_Backend/API_Specs/Product_API.md
- ❌ 02_Backend/API_Specs/Order_API.md
- ❌ 02_Backend/API_Specs/Finance_API.md
- ❌ 02_Backend/Database/ERD.md
- ❌ 02_Backend/Database/Table_Definitions.md
- ❌ 02_Backend/Services/*
- ❌ 02_Backend/Backend_Automation.md
- ❌ 03_Frontend/*
- ❌ 04_Plugin/*
- ❌ 05_AI/*
- ❌ 06_ETL/ETL_Pipelines.md
- ❌ 07_Testing/Test_Strategy.md
- ❌ 08_Deployment/*
- ❌ 09_Operations/*
- ❌ 10_Documents_Global/PROJECT_MAP.md
- ❌ 10_Documents_Global/README.md
- ❌ 10_Documents_Global/Changelog.md
- ❌ 11_References/Regulatory_Requirements.md
- ❌ 11_References/Glossary.md
## 文档优先级
### P0 - 核心文档（必须创建）
- 00_Business/Business_ClosedLoops.md ✅
- 01_Architecture/System_Architecture.md ✅
- 02_Backend/API_Specs/* (至少包含核心 API)
- 10_Documents_Global/README.md
### P1 - 重要文档（应该创建）
- 00_Business/Business_Blueprint.md ✅
- 01_Architecture/Module_Blueprints.md ✅
- 02_Backend/Database/ERD.md
- 02_Backend/Database/Table_Definitions.md
- 07_Testing/Test_Strategy.md
- 08_Deployment/Deployment_Guide.md
### P2 - 辅助文档（可以创建）
- 03_Frontend/*
- 04_Plugin/*
- 05_AI/*
- 06_ETL/*
- 09_Operations/*
- 11_References/*
## 文档迁移记录
### 从 docs11 迁移到 docs
| 原路径 | 新路径 | 状态 |
|--------|--------|------|
| docs11/00-documentation-layer.md | docs/00_Business/Business_ClosedLoops.md | ✅ 已迁移 |
| docs11/业务功能.md | docs/00_Business/Business_Features.md | ✅ 已迁移 |
| docs11/doc-index.md | docs/10_Documents_Global/DOC_INDEX.md | ✅ 已迁移 |
| docs11/Crawlful_Hub_Task_Overview_Full_v1.md | docs/00_Business/Task_Overview.md | ✅ 已迁移 |
| docs11/01-business-core/business-blueprint.md | docs/00_Business/Business_Blueprint.md | ✅ 已迁移 |
| docs11/01-business-core/业务9.md | docs/00_Business/Business_9.md | ✅ 已迁移 |
| docs11/02-data-api/data-api-specs.md | docs/02_Backend/API_Specs/Data_API_Specs.md | ✅ 已迁移 |
| docs11/03-architecture-tech/module-blueprints.md | docs/01_Architecture/Module_Blueprints.md | ✅ 已迁移 |
| docs11/03-architecture-tech/system-architecture.md | docs/01_Architecture/System_Architecture.md | ✅ 已迁移 |
| docs11/04-standards-governance/governance-standards.md | docs/00_Business/Governance_Standards.md | ✅ 已迁移 |
| docs11/05-quality-optimization/quality-optimization.md | docs/07_Testing/Quality_Optimization.md | ✅ 已迁移 |
---
**最后更新时间**：2026-03-17
**维护者**：Crawlful Hub 团队