添加产品规格文档并优化项目结构

Made-with: Cursor
This commit is contained in:
刘国栋
2026-04-30 18:37:46 +08:00
parent bf2551d529
commit fb309299bf
101 changed files with 9586 additions and 14386 deletions
+33 -25
View File
@@ -11,6 +11,8 @@
所有功能模块的详细说明:
### 核心功能
- [配置优化器](docs/features/CONFIG_OPTIMIZER_FEATURE.md)
- [内容质量指标](docs/features/CONTENT_METRICS_FEATURE.md)
- [内容质量评分](docs/features/CONTENT_SCORER_FEATURE.md)
@@ -28,15 +30,21 @@
- [话题集群](docs/features/TOPIC_CLUSTER_FEATURE.md)
- [工作流自动化](docs/features/WORKFLOW_AUTOMATION_FEATURE.md)
### GEO 增强功能(新增)
- [品牌知识库(RAG](docs/features/KNOWLEDGE_BASE_FEATURE.md) - 基于 RAG 的知识库管理
- [AI 搜索验证](docs/features/AI_SEARCH_VERIFIER_FEATURE.md) - 使用真实搜索引擎验证品牌提及
- [内容独特性检测](docs/features/CONTENT_UNIQUENESS_FEATURE.md) - 批量内容相似度检测
- [关键词数据增强](docs/features/KEYWORD_DATA_ENHANCER_FEATURE.md) - 基于历史数据优化关键词策略
- [LLM 工厂模块](docs/features/LLM_FACTORY_FEATURE.md) - 统一的 LLM 客户端构建接口
## 📊 分析报告
- [Tab 与模块映射](docs/analysis/TABS_TO_MODULES_ANALYSIS.md) - 主导航 Tab 与 `modules/ui/tab_*.py` 对应关系
- [Tab 拆分模式](docs/analysis/TAB_SPLIT_PATTERN.md) - Tab 拆分模式说明
- [分析准确性报告](docs/analysis/ANALYSIS_ACCURACY_REPORT.md)
- [代码文档分析](docs/analysis/CODE_DOCUMENTATION_ANALYSIS.md)
- [文档反向验证](docs/analysis/DOCUMENTATION_REVERSE_VERIFICATION.md)
- [功能重要性分析](docs/analysis/FEATURE_ANALYSIS.md)
- [功能优先级分析](docs/analysis/FEATURE_PRIORITY_ANALYSIS.md)
- [功能验证报告](docs/analysis/FUNCTION_VERIFICATION_REPORT.md)
- [GEO 合规性分析](docs/analysis/GEO_COMPLIANCE_ANALYSIS.md)
## 📘 指南文档
@@ -45,6 +53,7 @@
- [平台设置指南](docs/guides/PLATFORM_SETUP.md)
- [快速开始指南](docs/guides/QUICK_START_GUIDE.md)
- [数据存储指南](docs/guides/STORAGE_GUIDE.md)
- [根目录文件管理规则](docs/guides/ROOT_DIRECTORY_RULES.md)
## 🔧 实现文档
@@ -56,18 +65,25 @@
- [平台同步实现](docs/implementation/PLATFORM_SYNC_IMPLEMENTATION.md)
- [平台同步测试](docs/implementation/PLATFORM_SYNC_TEST.md)
## 🖥️ 前端结构与开发流程(拆分后)
- **入口**`geo_tool.py` 为 Streamlit 单入口,负责侧边栏配置、全局状态、主导航 Tabs 与对各 Tab 模块的调用。
- **Tab 模块**`modules/ui/tab_*.py`,每个文件提供 `render_tab_*(...)`,由主入口在对应 `with tabN:` 内调用。
- **公共 UI**`modules/ui/components.py` 提供 `sanitize_filename``render_section_header``render_download_button``render_tab_top_with_clear` 等,供各 Tab 复用。
- **状态与主题**`modules/ui/state.py` 统一初始化 `st.session_state``modules/ui/theme.py` 注入全局 CSS。
- **服务层**`modules/services/` 封装对业务模块的常用工作流(如 `schema_service``tech_config_service`),Tab 可按需调用。
**新增一个 Tab 的流程**
1.`modules/ui/` 下新建 `tab_新功能.py`,实现 `def render_tab_新功能(...)`,接收主入口传入的 `storage``ss_init``brand` 等依赖。
2.`geo_tool.py``st.tabs([...])` 中增加新 Tab 标签,并增加 `with tabN:` 块内调用 `tab_新功能.render_tab_新功能(...)`
3.`modules/ui/__init__.py``from . import (...)` 中增加 `tab_新功能`
详见:[Tab 与模块映射](docs/analysis/TABS_TO_MODULES_ANALYSIS.md)、[Tab 拆分模式](docs/analysis/TAB_SPLIT_PATTERN.md)。
## 📁 项目结构
- [项目结构分析](docs/guides/PROJECT_STRUCTURE_ANALYSIS.md) - 目录结构分析报告
- [目录结构优化方案](docs/DIRECTORY_STRUCTURE_OPTIMIZATION.md) - 优化方案详情
- [快速重组指南](docs/guides/QUICK_REORGANIZE.md) - 文件重组执行步骤
- [重组总结](docs/guides/REORGANIZATION_SUMMARY.md) - 重组工作总结
- [文档清理指南](docs/guides/DOCUMENTATION_CLEANUP_GUIDE.md) - 文档清理说明
- [最终优化指南](docs/guides/FINAL_OPTIMIZATION_GUIDE.md) - 深度优化执行指南
- [优化状态报告](docs/guides/OPTIMIZATION_STATUS.md) - 优化进度和状态
- [手动清理指南](docs/guides/MANUAL_CLEANUP_GUIDE.md) - 手动清理操作说明
- [高级优化方案](docs/guides/ADVANCED_OPTIMIZATION_PLAN.md) - 详细优化方案
- [引用路径更新总结](docs/guides/REFERENCE_UPDATE_SUMMARY.md) - 引用路径更新总结
项目采用模块化架构,详见 [README.md](README.md) 中的项目结构说明。
## 🔍 查找文档
@@ -84,17 +100,9 @@
- **功能配置** → [平台设置指南](docs/guides/PLATFORM_SETUP.md)
- **数据存储** → [数据存储指南](docs/guides/STORAGE_GUIDE.md)
- **平台同步** → [平台同步实现](docs/implementation/PLATFORM_SYNC_IMPLEMENTATION.md)
- **知识库** → [品牌知识库功能](docs/features/KNOWLEDGE_BASE_FEATURE.md)
- **AI 搜索验证** → [AI 搜索验证功能](docs/features/AI_SEARCH_VERIFIER_FEATURE.md)
---
💡 **提示**:如果找不到需要的文档,请查看 [README.md](README.md) 或使用搜索功能。
---
## 📌 重要规则
**根目录文档管理规则**
- ✅ 根目录只保留 `README.md``DOCS.md`
- ✅ 所有新文档应创建在 `docs/` 的相应子目录中
- 📖 详细规则请查看:[根目录文件管理规则](docs/guides/ROOT_DIRECTORY_RULES.md)
- 📋 清理清单请查看:[根目录文档清理清单](ROOT_DOCS_CLEANUP.md)
💡 **提示**:如果找不到需要的文档,请查看 [README.md](README.md) 或使用搜索功能。