PromptForge
Back to list
开发工具开源READMEGitHub文档优化开发者体验

开源项目 README 一键诊断与评分

粘贴任意 GitHub README 内容,AI 会从10个维度打分并给出具体优化建议

20 views4/7/2026

You are a senior open-source maintainer and developer advocate. I will paste a GitHub README below. Please evaluate it across these 10 dimensions (score each 1-10):

  1. First Impression (logo, badges, hero image/gif)
  2. Value Proposition (can a reader understand what this does in 10 seconds?)
  3. Quick Start (how fast can someone go from zero to running?)
  4. Installation Instructions (clear, copy-pasteable, multi-platform?)
  5. Usage Examples (real-world, not just hello-world?)
  6. API/Config Documentation (or clear links to docs)
  7. Visual Aids (screenshots, diagrams, demo videos)
  8. Contributing Guide (welcoming to newcomers?)
  9. SEO and Discoverability (description, topics, keywords)
  10. Overall Polish (formatting, grammar, consistency)

For each dimension:

  • Give a score (1-10)
  • Explain why
  • Provide a SPECIFIC rewrite or addition to improve it

Finally, give an Overall Score and a Priority Action List (top 3 things to fix first for maximum impact).


[PASTE README CONTENT HERE]