Files
ChouJuGEO/docs/guides/PROJECT_STRUCTURE_ANALYSIS.md
T
刘国栋 8f7f082c3d feat: 重构项目结构并添加平台同步基础架构
- 重构项目目录结构,将功能模块移至 modules/ 目录
- 创建平台同步基础架构,包括发布器基类和 GitHub 发布器
- 新增 UI 状态管理模块 (modules/ui/state.py) 统一管理会话状态
- 更新依赖配置,添加平台同步所需依赖 (httpx, pyperclip)
- 整理文档结构,将所有文档分类移至 docs/ 目录
- 添加 .cursorrules 文件定义项目开发规范
- 清理根目录重复文件,保持项目结构整洁
2026-01-30 10:21:29 +08:00

6.6 KiB
Raw Blame History

项目目录结构分析报告

📊 当前项目结构分析

文件统计

Python 文件(.py24个

  • 主程序:1个(geo_tool.py
  • 功能模块:18个
  • 平台同步模块:3个(在platform_sync/目录)
  • 示例/工具:2个

文档文件(.md34个

  • 功能文档(*_FEATURE.md):15个
  • 分析报告(*_ANALYSIS.md, *_REPORT.md):7个
  • 指南文档(*_GUIDE.md):5个
  • 实现文档:7个

配置文件3个

  • requirements.txt
  • .gitignore
  • .streamlit/config.toml

目录结构

geo_tool/
├── 根目录文件(50+个文件混在一起)
│   ├── Python模块文件(18个)
│   ├── 文档文件(34个)
│   ├── 配置文件(3个)
│   └── 主程序(1个)
│
└── platform_sync/(已有子目录)
    ├── __init__.py
    ├── base_publisher.py
    ├── github_publisher.py
    └── copy_manager.py

🔍 文件引用关系分析

Python 文件导入关系

geo_tool.py 导入的模块(18个):

from data_storage import DataStorage
from keyword_tool import KeywordTool
from content_scorer import ContentScorer
from eeat_enhancer import EEATEnhancer
from semantic_expander import SemanticExpander
from fact_density_enhancer import FactDensityEnhancer
from schema_generator import SchemaGenerator
from topic_cluster import TopicCluster
from multimodal_prompt import MultimodalPromptGenerator
from roi_analyzer import ROIAnalyzer
from workflow_automation import WorkflowManager, WorkflowStep
from keyword_mining import KeywordMining
from optimization_techniques import OptimizationTechniqueManager
from content_metrics import ContentMetricsAnalyzer
from technical_config_generator import TechnicalConfigGenerator
from negative_monitor import NegativeMonitor
from resource_recommender import ResourceRecommender

platform_sync 模块:

  • 使用相对导入,已有包结构

文档引用关系

README.md 引用的文档:

  • INTEGRATION_NOTES.md
  • STORAGE_GUIDE.md
  • PLATFORM_SETUP.md
  • IMPLEMENTATION_SUMMARY.md
  • PLATFORM_SYNC_IMPLEMENTATION.md
  • 15个 *_FEATURE.md 文件

功能文档 之间的引用:

  • 各功能文档相互引用
  • 引用实现模块(.py文件)
  • 引用其他分析文档

🎯 优化建议

1. 目录结构优化

建议结构

geo_tool/
├── README.md
├── requirements.txt
├── .gitignore
├── .streamlit/
├── geo_tool.py
├── modules/              # 新增:功能模块目录
│   ├── __init__.py
│   └── [18个模块文件]
├── platform_sync/        # 已有
└── docs/                 # 新增:文档目录
    ├── features/         # 功能文档
    ├── analysis/         # 分析报告
    ├── guides/           # 指南文档
    └── implementation/   # 实现文档

2. 导入路径更新

需要更新的导入

  • geo_tool.py:所有模块导入添加 modules. 前缀
  • storage_example.py:更新 data_storage 导入

3. 文档路径更新

需要更新的文档引用

  • 所有 .md 文件中的文档路径引用
  • README.md 中的文档链接

📋 实施计划

阶段1:准备(已完成)

  • 创建优化方案文档
  • 创建目录结构
  • 创建更新脚本

阶段2:文件移动(待执行)

  1. 关闭所有打开的文件(IDE、编辑器等)
  2. 运行文件移动脚本或手动移动
  3. 验证文件移动成功

阶段3:路径更新(待执行)

  1. 运行 scripts/update_imports.py 更新Python导入
  2. 运行 scripts/update_doc_references.py 更新文档引用
  3. 手动检查关键文件

阶段4:验证(待执行)

  1. 运行 python geo_tool.py 测试导入
  2. 检查文档链接是否正常
  3. 验证所有功能是否正常

📝 详细文件清单

需要移动到 modules/ 的文件(18个)

  1. data_storage.py
  2. keyword_tool.py
  3. content_scorer.py
  4. eeat_enhancer.py
  5. semantic_expander.py
  6. fact_density_enhancer.py
  7. schema_generator.py
  8. topic_cluster.py
  9. multimodal_prompt.py
  10. roi_analyzer.py
  11. workflow_automation.py
  12. keyword_mining.py
  13. optimization_techniques.py
  14. content_metrics.py
  15. technical_config_generator.py
  16. negative_monitor.py
  17. resource_recommender.py
  18. config_optimizer.py
  19. storage_example.py(可选)

需要移动到 docs/features/ 的文件(15个)

  1. CONFIG_OPTIMIZER_FEATURE.md
  2. CONTENT_METRICS_FEATURE.md
  3. CONTENT_SCORER_FEATURE.md
  4. EEAT_FEATURE.md
  5. FACT_DENSITY_FEATURE.md
  6. JSON_LD_SCHEMA_FEATURE.md
  7. KEYWORD_MINING_FEATURE.md
  8. MULTIMODAL_FEATURE.md
  9. NEGATIVE_MONITOR_FEATURE.md
  10. OPTIMIZATION_TECHNIQUES_FEATURE.md
  11. RESOURCE_RECOMMENDER_FEATURE.md
  12. ROI_ANALYSIS_FEATURE.md
  13. SEMANTIC_EXPANSION_FEATURE.md
  14. TECHNICAL_CONFIG_FEATURE.md
  15. TOPIC_CLUSTER_FEATURE.md
  16. WORKFLOW_AUTOMATION_FEATURE.md

需要移动到 docs/analysis/ 的文件(7个)

  1. ANALYSIS_ACCURACY_REPORT.md
  2. CODE_DOCUMENTATION_ANALYSIS.md
  3. DOCUMENTATION_REVERSE_VERIFICATION.md
  4. FEATURE_ANALYSIS.md
  5. FEATURE_PRIORITY_ANALYSIS.md
  6. FUNCTION_VERIFICATION_REPORT.md
  7. GEO_COMPLIANCE_ANALYSIS.md

需要移动到 docs/guides/ 的文件(5个)

  1. QUICK_START_GUIDE.md
  2. STORAGE_GUIDE.md
  3. PLATFORM_SETUP.md
  4. LAYOUT_UPGRADE_GUIDE.md
  5. DECISION_GUIDE.md

需要移动到 docs/implementation/ 的文件(7个)

  1. IMPLEMENTATION_SUMMARY.md
  2. PLATFORM_SYNC_ANALYSIS.md
  3. PLATFORM_SYNC_IMPLEMENTATION.md
  4. PLATFORM_SYNC_TEST.md
  5. INTEGRATION_NOTES.md
  6. FEATURES_COMPLETE_LIST.md
  7. ADVANCED_FEATURES.md

优化后的优势

  1. 清晰的目录结构:文件按功能分类,易于查找和管理
  2. 模块化组织:功能模块集中管理,便于维护和扩展
  3. 文档分类清晰:功能文档、分析报告、指南文档分开管理
  4. 符合最佳实践:遵循Python项目标准目录结构
  5. 便于协作:团队成员更容易理解项目结构

🚨 注意事项

  1. 文件占用:移动文件前,确保所有文件未被IDE或其他程序打开
  2. 路径更新:移动文件后,必须运行更新脚本更新所有引用路径
  3. 测试验证:完成移动和更新后,务必测试程序是否正常运行
  4. Git提交:建议分步骤提交,便于回滚和追踪变更

📚 相关文档

  • docs/DIRECTORY_STRUCTURE_OPTIMIZATION.md - 详细的优化方案和实施步骤
  • scripts/update_imports.py - 自动更新Python导入路径的脚本
  • scripts/update_doc_references.py - 自动更新文档路径引用的脚本