# Readme Polish

> Improve an existing README by checking its facts, first-screen hierarchy and local links. Includes a static gate and an audit-only mode; visual rendering still needs review.

- Canonical page: https://ai-skills-catalog.com/skills/readme-polish
- Category: Documentation
- Author: zhengqiuyang
- License: MIT
- Source: https://github.com/alirezarezvani/claude-skills/tree/main/engineering/readme-polish
- Last updated: 2026-11-21
- Risk level: Low
- Declared permissions: Read project files; Write generated skill files

## Compatibility

- Claude: Packaged. Package: https://ai-skills-catalog.com/api/skills/readme-polish/package?agent=Claude
- Codex: Packaged. Package: https://ai-skills-catalog.com/api/skills/readme-polish/package?agent=Codex
- GPT: Packaged. Package: https://ai-skills-catalog.com/api/skills/readme-polish/package?agent=GPT
- Gemini: Packaged. Package: https://ai-skills-catalog.com/api/skills/readme-polish/package?agent=Gemini
- Cursor: Packaged. Package: https://ai-skills-catalog.com/api/skills/readme-polish/package?agent=Cursor
- OpenCode: Packaged. Package: https://ai-skills-catalog.com/api/skills/readme-polish/package?agent=OpenCode

## Sections of SKILL.md

- Before starting
- Modes
- Workflow
- Example
- Output
- Related skills

## Bundled files

- .claude-plugin/plugin.json
- README.md
- evals/evals.json
- references/archetypes.md
- references/checklist.md
- references/components.md
- scripts/check_readme.py
- LICENSE

## Installation

### Claude

1. Download the Claude package from the skill page. The ZIP contains one folder named after the skill, with SKILL.md and any bundled reference files.
2. For Claude Code, unpack the folder into ~/.claude/skills/ to use it in every project, or into .claude/skills/ inside a repository to share it with your team.
3. For Claude apps, upload the ZIP in the Skills section of the capabilities settings.
4. Start a new session and describe the task in your own words. Claude picks the skill when the request matches its description.

### Codex

1. Download the Codex package. The ZIP contains one folder named after the skill, with SKILL.md and bundled resources.
2. Unpack the complete folder into .agents/skills/ inside your repository, or into ~/.agents/skills/ for personal use. Preserve its relative reference-file paths.
3. Start a new Codex session and invoke the skill by name or with $skill-name, or describe a matching task.
4. AGENTS.md is separate project guidance. The ZIP does not generate or modify that file.

### GPT

1. Download the GPT package from the skill page.
2. Create or edit a custom GPT (or a ChatGPT project) and paste the contents of SKILL.md into the instructions field.
3. Upload the bundled reference files as knowledge so the GPT can consult them.
4. Test with one of the example prompts from the skill page and adjust the instructions if your use case differs.

### Gemini

1. Download the Gemini package from the skill page.
2. For a project, unpack the complete folder into .gemini/skills/ or .agents/skills/. For personal use, use ~/.gemini/skills/ or ~/.agents/skills/.
3. Run /skills reload in Gemini CLI, then /skills list to check discovery. There is no need to paste the skill into GEMINI.md.
4. Test a matching task and verify the referenced tools and files are available.

### Cursor

1. Download the Cursor package from the skill page.
2. Unpack the complete skill folder into .cursor/skills/ or .agents/skills/ in your project. For personal local use, ~/.cursor/skills/ and ~/.agents/skills/ are also supported.
3. Start a new Cursor session. Type / in Agent chat and select the skill name, or describe a matching task.
4. Commit the skill folder and resources for team use. Personal local skills are not automatically available to remote agents or automation runs.

### OpenCode

1. Download the OpenCode package from the skill page.
2. Unpack the complete folder into .opencode/skills/ in your project, or ~/.config/opencode/skills/ for personal use. OpenCode also supports .agents/skills/ and .claude/skills/ compatibility locations.
3. Keep supporting files at their original relative paths. AGENTS.md is separate project-wide guidance and is not generated by this ZIP.
4. Start OpenCode in the project and test a matching task with the model and permissions you use.

## FAQ

### What does the Readme Polish skill do?

Improve an existing README by checking its facts, first-screen hierarchy and local links. Includes a static gate and an audit-only mode; visual rendering still needs review.

### Which AI agents can use Readme Polish?

Packages for Claude, Codex and 4 more are built from the same source instructions.

### How do I install Readme Polish in Claude?

Download the Claude package from the skill page. The ZIP contains one folder named after the skill, with SKILL.md and any bundled reference files. For Claude Code, unpack the folder into ~/.claude/skills/ to use it in every project, or into .claude/skills/ inside a repository to share it with your team.

### Who made Readme Polish and what is the license?

Readme Polish is published by zhengqiuyang under the MIT license. The source is https://github.com/alirezarezvani/claude-skills/tree/main/engineering/readme-polish. The catalog keeps the original attribution.

### What permissions does Readme Polish need?

Declared permissions: read project files, write generated skill files. Risk level: low. Check the scripts in the source before running them.

## Related Documentation skills

- [Atlassian Templates](https://ai-skills-catalog.com/skills/atlassian-templates): Create reusable Jira and Confluence templates through stakeholder discovery, structure design, implementation and governance. The bundled scaffolder produces storage-format template bodies, while references cover macros, change control and organization-wide reuse.
- [Book to Skill](https://ai-skills-catalog.com/skills/book-to-skill): Convert documents you can provide into a small, indexed skill with chapter references, glossary and decision aids. Includes extraction, budget checks and a redistribution-rights gate.
- [Code to PRD](https://ai-skills-catalog.com/skills/code-to-prd): Infer product requirements from an existing codebase.
- [Quality Documentation Manager](https://ai-skills-catalog.com/skills/quality-documentation-manager): Designs document control for a quality-management system, including numbering, revision history, review and approval routing, distribution and obsolescence. Metadata validators and references support electronic-record and signature-control planning.
- [Arquiteto De Empresa](https://ai-skills-catalog.com/skills/arquiteto-de-empresa-2): Interview a founder through a phased company-design process and capture the business as a cross-linked Open Knowledge Format bundle. Bundled scaffolding, linting and indexing scripts support typed Markdown concepts, navigation indexes and a progress log.
- [Md Document](https://ai-skills-catalog.com/skills/md-document): Convert long Markdown documents into a single HTML artifact through a parser, renderer and interactivity injector. The package supports a table of contents, search, scroll tracking and code-copy controls with supplied design tokens.
