删除不再需要的归档文件和过时的文档模板,包括多个README、安全策略、前端集成蓝图等文件,同时移除了未使用的业务文档和项目结构文件。 优化项目结构,移除冗余文件,保持代码库整洁。主要删除archive/handover目录下的多个文件及doc目录下的部分文档模板。
3.9 KiB
3.9 KiB
📚 Crawlful Hub Documentation Index
说明: 本文档索引帮助开发者快速定位项目文档。 核心任务表: Task_Overview.md (95个任务追踪)
1️⃣ 业务层 (00_Business)
业务战略、闭环流程、功能规格、行业标杆
| 文件 | 说明 |
|---|---|
| Business_ClosedLoops.md | 业务闭环文档(核心): 30个完整业务闭环流程,涵盖TOC/TOB双向闭环 |
| Business_Blueprint.md | 业务蓝图: 项目目标、技术栈、核心业务模块功能规格、行业标杆参考 |
| Governance_Standards.md | 治理标准: 开发规范、协作协议、任务规格、运维治理 |
| Task_Overview.md | 任务概览: 95个任务追踪,包含前后端、插件、AI、数据、运维模块 |
2️⃣ 架构层 (01_Architecture)
系统架构、模块蓝图、技术栈
| 文件 | 说明 |
|---|---|
| System_Architecture.md | 系统架构: 后端、前端、插件架构设计及依赖规则 |
| Module_Blueprints.md | 模块蓝图: OMS, WMS, Finance, MKT等模块的前端集成蓝图 |
3️⃣ 后端文档 (02_Backend)
API规范、数据库设计、服务模块
| 文件 | 说明 |
|---|---|
| API_Specs/Data_API_Specs.md | 数据API规范: 数据库Schema、核心业务流程图及API映射 |
待创建:
Backend_Design.md- 后端设计API_Specs/Product_API.md- 商品APIAPI_Specs/Order_API.md- 订单APIAPI_Specs/Finance_API.md- 财务APIDatabase/ERD.md- 数据库设计图Database/Table_Definitions.md- 表定义
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 | 质量优化: 交付标准、体验检查、文档报告 |
待创建:
Test_Strategy.md- 测试策略
8️⃣ 全局文档 (10_Documents_Global)
项目地图、文档索引
| 文件 | 说明 |
|---|---|
| README.md | 文档结构说明: 完整目录结构及文档分类说明 |
| PROJECT_MAP.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