ReddRadar
Agent skill
readme-polish
Improve a README for clarity and completeness. Use when a junior developer needs guidance on documenting setup and usage.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/readme-polish
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
- Ensure install, run, and test steps are present and ordered.
- Add required environment variables and configuration notes.
- 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.
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?