llm-content-creator 0.1.0

package/docs/README.md

@@ -0,0 +1,145 @@
+# Content Creator 文档导航
+
+欢迎来到 Content Creator 项目文档中心！这里包含了项目的所有文档。
+
+---
+
+## 📚 核心文档
+
+### 快速开始
+- [🚀 快速开始指南](./quick-start.md) - 5 分钟上手使用 Content Creator
+- [📖 用户操作手册](./user-guide.md) - 完整的用户使用指南
+
+### 架构设计
+- [🏗️ 系统架构设计（完整版）](./architecture-complete.md) - 完整的系统架构设计文档（139K，5500+ 行）
+- [⚙️ 工作流架构](./workflow-architecture.md) - LangGraph 工作流设计详解
+- [✅ 质量检查架构](./quality-check-architecture.md) - 质量检查系统架构
+- [💾 存储机制说明](./storage-guide.md) - PostgreSQL 数据存储设计
+
+### 技术参考
+见 [技术参考文档](#技术参考文档) 章节
+
+---
+
+## 🔧 技术参考文档
+
+[references/](./references/) 目录包含各种技术参考指南：
+
+| 文档 | 说明 |
+|------|------|
+| [BullMQ 快速参考](./references/bullmq-quick-reference.md) | BullMQ 任务队列快速入门 |
+| [监控优化指南](./references/monitoring-optimization-guide.md) - 系统监控和性能优化 |
+| [性能优化指南](./references/performance-optimization-guide.md) | 应用性能调优指南 |
+
+---
+
+## 📦 归档文档
+
+[archive/](./archive/) 目录包含了项目开发过程中的所有历史文档：
+
+### 阶段文档
+按开发阶段组织的文档，记录了项目的完整开发历程：
+
+```
+archive/phases/
+├── phase-0/       # 阶段 0：环境准备
+├── phase-1/       # 阶段 1：核心数据层
+├── phase-2/       # 阶段 2：应用层
+│   ├── phase-2a/  # 阶段 2a：同步执行器
+│   └── phase-2b/  # 阶段 2b：异步执行器
+├── phase-3/       # 阶段 3：异步任务系统
+└── phase-4/       # 阶段 4：测试与完善
+```
+
+### 会话总结
+每次开发会话的总结文档，记录了当天的进展和问题。
+
+### 测试报告
+各个阶段的测试报告和覆盖率分析。
+
+### 进度报告
+项目进度报告和里程碑总结。
+
+### 实施文档
+实施指南和问题分析文档。
+
+---
+
+## 📖 文档使用指南
+
+### 新手入门
+1. 先阅读 [快速开始指南](./quick-start.md) 了解项目
+2. 查看 [用户操作手册](./user-guide.md) 学习如何使用
+3. 需要深入了解时，阅读 [系统架构设计](./architecture-complete.md)
+
+### 开发者
+1. 架构设计：[系统架构设计（完整版）](./architecture-complete.md)
+2. 工作流实现：[工作流架构](./workflow-architecture.md)
+3. 质检系统：[质量检查架构](./quality-check-architecture.md)
+4. 技术细节：见 [技术参考文档](#技术参考文档)
+
+### 运维人员
+1. [BullMQ 快速参考](./references/bullmq-quick-reference.md) - 任务队列管理
+2. [监控优化指南](./references/monitoring-optimization-guide.md) - 系统监控
+3. [性能优化指南](./references/performance-optimization-guide.md) - 性能调优
+
+### 查阅历史
+- 项目开发历史：查看 [archive/phases/](./archive/phases/)
+- 特定会话记录：查看 [archive/sessions/](./archive/sessions/)
+- 测试历史：查看 [archive/reports/test-reports/](./archive/reports/test-reports/)
+
+---
+
+## 📂 文档结构
+
+```
+docs/
+├── README.md                          # 📍 本文档
+├── quick-start.md                     # 🚀 快速开始
+├── user-guide.md                      # 📖 用户手册
+├── architecture-complete.md           # 🏗️ 架构设计
+├── workflow-architecture.md           # ⚙️ 工作流架构
+├── quality-check-architecture.md      # ✅ 质检架构
+├── storage-guide.md                   # 💾 存储机制
+├── DOCUMENTATION-ANALYSIS.md          # 📊 文档分析报告
+├── references/                        # 🔧 技术参考
+│   ├── bullmq-quick-reference.md
+│   ├── monitoring-optimization-guide.md
+│   └── performance-optimization-guide.md
+└── archive/                           # 📦 归档文档
+    ├── phases/                        # 阶段文档
+    ├── sessions/                      # 会话总结
+    └── reports/                       # 各类报告
+        ├── test-reports/
+        └── progress-reports/
+```
+
+---
+
+## 🔍 快速查找
+
+**我想...**
+- 快速上手 → [快速开始指南](./quick-start.md)
+- 了解架构 → [系统架构设计](./architecture-complete.md)
+- 使用系统 → [用户操作手册](./user-guide.md)
+- 理解工作流 → [工作流架构](./workflow-architecture.md)
+- 了解质检 → [质量检查架构](./quality-check-architecture.md)
+- 查看历史 → [archive/](./archive/)
+- 队列管理 → [BullMQ 参考](./references/bullmq-quick-reference.md)
+- 性能优化 → [性能优化指南](./references/performance-optimization-guide.md)
+
+---
+
+## 📝 文档维护
+
+- 文档最后更新：2026-01-22
+- 维护者：Content Creator Team
+- 问题反馈：请在项目仓库提交 Issue
+
+---
+
+## 🔗 相关链接
+
+- [项目主 README](../README.md)
+- [测试文档](../tests/README.md)
+- [开发文档](../dev/active/implementation-guide.md)