Skip to content

SKILL.md

Latest commit

 

History

History
27 lines (21 loc) · 749 Bytes

SKILL.md

File metadata and controls

27 lines (21 loc) · 749 Bytes
name readme-polish
description Improve a README for clarity and completeness. Use when a junior developer needs guidance on documenting setup and usage.

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.