smithery/proflead

readme-polish

Improve a README for clarity and completeness. Use when a junior developer needs guidance on documenting setup and usage.

Installation

$ npx skills add smithery/proflead --skill readme-polish

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from smithery/proflead · top by installs.

npx skills add smithery/proflead

Browse all from smithery/proflead

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 749 B
  • docs SUMMARY.md 142 B

History

  1. First recorded snapshot · 0 installs

SKILL.md

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.