目录
目录README.md

开源项目文档质量检测工具

这是一个用于自动化分析 GitHub 开源项目文档质量的工具。它结合了基于规则的静态检查和基于大模型(LLM)的语义分析,为开源项目提供多维度的文档评估报告。

✨ 功能特性

  • 文档完整性检查 (Completeness Check)

    • 自动扫描项目根目录及 /docs 目录。
    • 检查关键文件是否存在(如 README, LICENSE, CONTRIBUTING, CODE_OF_CONDUCT 等)。
    • 根据文件重要性进行加权评分。
  • 格式规范检查 (Format Check)

    • 基于规则对 Markdown 文件进行语法分析。
    • 检测行长过长、代码块闭合缺失、标题层级混乱、空链接等问题。
  • 语义深度分析 (Semantic Check)

    • 集成 Alibaba Cloud DashScope (通义千问 Qwen-Plus) 模型。
    • 对 README 等核心文档进行内容理解,生成摘要。
    • 评估文档的可读性、逻辑性,并提供具体的改进建议。
    • 支持 Mock 模式,无 API Key 也可体验基础功能。
  • 可视化报告

    • 提供现代化的 React 前端界面。
    • 直观展示项目总分、雷达图维度分析及详细的问题列表。

🛠️ 技术栈

  • 后端: Python 3.8+, FastAPI, Uvicorn
  • 前端: React 18, Vite, Chart.js, Tailwind CSS (或类似样式库)
  • AI 能力: OpenAI SDK (兼容调用阿里云 DashScope API)
  • 工具库: PyGithub (GitHub API), Markdown-it-py
关于
18.9 MB
邀请码