chore: 清理归档文件和文档模板
删除不再需要的归档文件和过时的文档模板,包括多个README、安全策略、前端集成蓝图等文件,同时移除了未使用的业务文档和项目结构文件。 优化项目结构,移除冗余文件,保持代码库整洁。主要删除archive/handover目录下的多个文件及doc目录下的部分文档模板。
This commit is contained in:
@@ -1,56 +1,127 @@
|
||||
# 📚 Crawlful Hub Documentation Index
|
||||
|
||||
> **说明**: 本文件是项目的深度索引,将全量文档聚合为核心蓝图与规格书,帮助开发者快速定位。
|
||||
> **核心任务表**: [Crawlful_Hub_Task_Overview_Full_v1.md](Crawlful_Hub_Task_Overview_Full_v1.md) (唯一业务到模块任务表)
|
||||
> **说明**: 本文档索引帮助开发者快速定位项目文档。
|
||||
> **核心任务表**: [Task_Overview.md](../00_Business/Task_Overview.md) (95个任务追踪)
|
||||
|
||||
---
|
||||
|
||||
## 1️⃣ 业务核心 (01-business-core)
|
||||
> 业务战略、功能蓝图、行业标杆
|
||||
## 1️⃣ 业务层 (00_Business)
|
||||
> 业务战略、闭环流程、功能规格、行业标杆
|
||||
|
||||
| 文件 | 说明 |
|
||||
|------|------|
|
||||
| [business-blueprint.md](01-business-core/business-blueprint.md) | **核心蓝图**: 包含项目目标、业务闭环、模块功能及标杆参考 (Merged) |
|
||||
| [业务功能.md](业务功能.md) | **功能详述**: 聚合了订单、库存、财务、调价、广告等全量业务操作细节 (Updated) |
|
||||
| [Business_ClosedLoops.md](../00_Business/Business_ClosedLoops.md) | **业务闭环文档(核心)**: 30个完整业务闭环流程,涵盖TOC/TOB双向闭环 |
|
||||
| [Business_Blueprint.md](../00_Business/Business_Blueprint.md) | **业务蓝图**: 项目目标、技术栈、核心业务模块功能规格、行业标杆参考 |
|
||||
| [Governance_Standards.md](../00_Business/Governance_Standards.md) | **治理标准**: 开发规范、协作协议、任务规格、运维治理 |
|
||||
| [Task_Overview.md](../00_Business/Task_Overview.md) | **任务概览**: 95个任务追踪,包含前后端、插件、AI、数据、运维模块 |
|
||||
|
||||
---
|
||||
|
||||
## 2️⃣ 数据与 API (02-data-api)
|
||||
> 数据 Schema、业务流程、接口规格
|
||||
|
||||
| 文件 | 说明 |
|
||||
|------|------|
|
||||
| [data-api-specs.md](02-data-api/data-api-specs.md) | **数据接口规格**: 包含数据库 Schema、核心业务流程图及全量 API 映射 (Merged) |
|
||||
|
||||
---
|
||||
|
||||
## 3️⃣ 架构与技术 (03-architecture-tech)
|
||||
## 2️⃣ 架构层 (01_Architecture)
|
||||
> 系统架构、模块蓝图、技术栈
|
||||
|
||||
| 文件 | 说明 |
|
||||
|------|------|
|
||||
| [system-architecture.md](03-architecture-tech/system-architecture.md) | **系统架构**: 包含后端、前端、插件架构设计及依赖规则 (Merged) |
|
||||
| [module-blueprints.md](03-architecture-tech/module-blueprints.md) | **功能蓝图**: 包含 OMS, WMS, Finance, MKT 等模块的前端集成蓝图 (Merged) |
|
||||
| [System_Architecture.md](../01_Architecture/System_Architecture.md) | **系统架构**: 后端、前端、插件架构设计及依赖规则 |
|
||||
| [Module_Blueprints.md](../01_Architecture/Module_Blueprints.md) | **模块蓝图**: OMS, WMS, Finance, MKT等模块的前端集成蓝图 |
|
||||
|
||||
---
|
||||
|
||||
## 4️⃣ 规范与治理 (04-standards-governance)
|
||||
> 开发标准、协作协议、运维治理
|
||||
## 3️⃣ 后端文档 (02_Backend)
|
||||
> API规范、数据库设计、服务模块
|
||||
|
||||
| 文件 | 说明 |
|
||||
|------|------|
|
||||
| [governance-standards.md](04-standards-governance/governance-standards.md) | **治理规范**: 包含开发标准、JSDoc 规范、协作协议及风险治理 (Refactored) |
|
||||
| [API_Specs/Data_API_Specs.md](../02_Backend/API_Specs/Data_API_Specs.md) | **数据API规范**: 数据库Schema、核心业务流程图及API映射 |
|
||||
|
||||
**待创建**:
|
||||
- `Backend_Design.md` - 后端设计
|
||||
- `API_Specs/Product_API.md` - 商品API
|
||||
- `API_Specs/Order_API.md` - 订单API
|
||||
- `API_Specs/Finance_API.md` - 财务API
|
||||
- `Database/ERD.md` - 数据库设计图
|
||||
- `Database/Table_Definitions.md` - 表定义
|
||||
|
||||
---
|
||||
|
||||
## 5️⃣ 质量与优化 (05-quality-optimization)
|
||||
> 交付标准、体验检查、文档报告
|
||||
## 4️⃣ 前端文档 (03_Frontend)
|
||||
> 前端设计、UI组件、页面流转
|
||||
|
||||
**待创建**:
|
||||
- `Frontend_Design.md` - 前端设计
|
||||
- `UI_Components.md` - UI组件
|
||||
- `Pages_Flow.md` - 页面流转
|
||||
- `API_Consumption.md` - API调用
|
||||
- `Frontend_Automation.md` - 前端自动化
|
||||
|
||||
---
|
||||
|
||||
## 5️⃣ 插件文档 (04_Plugin)
|
||||
> 插件设计、DOM交互、自动化脚本
|
||||
|
||||
**待创建**:
|
||||
- `Plugin_Design.md` - 插件设计
|
||||
- `DOM_Interaction.md` - DOM交互
|
||||
- `Automation_Scripts.md` - 自动化脚本
|
||||
- `Plugin_Agent_Integration.md` - 插件集成
|
||||
|
||||
---
|
||||
|
||||
## 6️⃣ AI文档 (05_AI)
|
||||
> AI策略、上下文、任务、模型集成
|
||||
|
||||
**待创建**:
|
||||
- `AI_Strategy.md` - AI策略
|
||||
- `AI_Context.md` - AI上下文
|
||||
- `AI_Tasks.md` - AI任务
|
||||
- `AI_Model_Integration.md` - AI模型集成
|
||||
|
||||
---
|
||||
|
||||
## 7️⃣ 测试文档 (07_Testing)
|
||||
> 测试策略、质量优化
|
||||
|
||||
| 文件 | 说明 |
|
||||
|------|------|
|
||||
| [quality-optimization.md](05-quality-optimization/quality-optimization.md) | **质量标准**: 包含前端交付质量标准、UX 检查清单及文档优化报告 (Merged) |
|
||||
| [Quality_Optimization.md](../07_Testing/Quality_Optimization.md) | **质量优化**: 交付标准、体验检查、文档报告 |
|
||||
|
||||
**待创建**:
|
||||
- `Test_Strategy.md` - 测试策略
|
||||
|
||||
---
|
||||
|
||||
### 📂 归档 (Archive)
|
||||
- [archive/](archive/) - 历史方案、旧版任务记录
|
||||
## 8️⃣ 全局文档 (10_Documents_Global)
|
||||
> 项目地图、文档索引
|
||||
|
||||
| 文件 | 说明 |
|
||||
|------|------|
|
||||
| [README.md](../README.md) | **文档结构说明**: 完整目录结构及文档分类说明 |
|
||||
| [PROJECT_MAP.md](./PROJECT_MAP.md) | **项目地图**: 模块依赖关系及文档结构图 |
|
||||
| [DOC_INDEX.md](./DOC_INDEX.md) | **文档索引**: 本文档,快速定位所有文档 |
|
||||
|
||||
---
|
||||
|
||||
## 📊 文档完成度
|
||||
|
||||
| 模块 | 已存在 | 缺失 | 完成率 |
|
||||
|------|--------|------|--------|
|
||||
| 00_Business | 4 | 0 | 100% ✅ |
|
||||
| 01_Architecture | 2 | 0 | 100% ✅ |
|
||||
| 02_Backend | 1 | 6 | 14% 🔴 |
|
||||
| 03_Frontend | 0 | 5 | 0% 🔴 |
|
||||
| 04_Plugin | 0 | 4 | 0% 🔴 |
|
||||
| 05_AI | 0 | 4 | 0% 🔴 |
|
||||
| 07_Testing | 1 | 1 | 50% 🟡 |
|
||||
| 10_Documents_Global | 3 | 0 | 100% ✅ |
|
||||
| **总计** | **11** | **20** | **35%** |
|
||||
|
||||
---
|
||||
|
||||
## 🔗 相关资源
|
||||
|
||||
- **项目规则**: `.trae/rules/project-specific-rules.md` - 硬性约束和配置
|
||||
- **代码库**: `server/src/`, `console/src/`, `extension/src/`
|
||||
|
||||
---
|
||||
|
||||
*最后更新: 2026-03-18*
|
||||
|
||||
Reference in New Issue
Block a user