返回 Skill 列表
extension
分类: 开发与工程无需 API Key

readme-polish

改进README文件以提高清晰度和完整性。当初级开发人员需要关于文档设置和使用的指导时使用。

person作者: jakexiaohubgithub

README Polish

Purpose

Improve a README for clarity and completeness.

Inputs to request

  • Current README content.
  • Setup prerequisites and runtime versions.
  • Common failure modes or FAQs.

Workflow

  1. Ensure install, run, and test steps are present and ordered.
  2. Add required environment variables and configuration notes.
  3. Clarify expected outputs and common troubleshooting tips.

Output

  • Revised README section suggestions.
  • Checklist of missing items.

Quality bar

  • Keep instructions concise and copy-pasteable.
  • Surface the most common pitfalls early.