Menu
Use when someone asks to update the readme, reflect changes in the docs, sync documentation with code, or when readme needs updating.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
Use when someone wants to create or update an understand-project skill for the current project, generate project onboarding context, document the project structure for future Claude sessions, or refresh an outdated understand-project skill.
Use when creating new skills, optimizing existing skills, or auditing skill quality. Guides skill development following Claude Code official best practices.
Use when someone asks to review their UI, audit their frontend design, improve their website's design or layout, suggest UI/UX improvements, or enhance the visual styling of their frontend. Also triggers on phrases like "review my UI", "improve my frontend design", "audit my design", or "make my website look better".
Use when someone wants to add a project to their portfolio, generate a portfolio entry for the current project, document a project for the portfolio website, or update the portfolio with a new project.
Generate 8 chamber layouts for a tileset and write chambers.json. Run multiple instances in parallel for different tilesets.
Use when adding a new enemy, implementing enemy animations, setting up a new enemy type, or onboarding new enemy sprites into the game.
| name | update-readme |
| description | Use when someone asks to update the readme, reflect changes in the docs, sync documentation with code, or when readme needs updating. |
| argument-hint | ["description of what changed"] |
Keeps the README in sync with code changes. Identifies only the affected sections, proposes targeted updates that preserve the existing tone and formatting, and waits for approval before writing anything.
Find and read the README file. Check for README.md, README.rst, or docs/README.md in the project root. If none found, ask the user where it is.
Note the existing:
If `` was provided, use it as the description of what changed.
Otherwise, run git diff HEAD to get recent unstaged changes. If that's empty, try git diff HEAD~1 to get the last commit's diff. If still empty, ask the user to describe what changed.
Based on the changes, determine which README sections need updating. Common mappings:
List the affected sections explicitly before proposing any changes.
For each affected section, show:
Format your proposal clearly so the user can compare. Match the existing tone and formatting exactly — do not restructure, reformat, or improve other parts of the README.
If a section doesn't exist yet but should be added, show where it would be inserted and its full content.
After presenting all proposed changes, ask the user:
"Does this look good? I'll apply these changes once you confirm."
Do NOT write anything to the README until the user approves. If the user requests edits, revise and re-present before asking again.
Once approved, use Edit to apply each change to the README. Update only the approved sections. Do not touch anything else.
Confirm when done: "README updated — [list of sections changed]."
