Create a Claude Code project skill to review a README, then check whether it flags missing setup instructions on a sample project.
Create a Claude Code project skill to review a README, then check whether it flags missing setup instructions on a sample project.
A skill stores instructions for a repeatable task. This example reviews a README and returns findings for a reviewer. Try it in a sample project with a README.md file you control.
In the project root, create .claude/skills/docs-review/SKILL.md. The disable-model-invocation setting keeps invocation manual. This example asks Claude to return findings without editing files.
--- name: docs-review description: Review project README setup and run instructions disable-model-invocation: true --- Review README.md for the project purpose, prerequisites, setup and run instructions. Cite a line or heading for each finding. Flag missing instructions and do not invent commands. Return a checklist. Do not edit files.
Open Claude Code in the project and enter /docs-review. Start with a README that has no run instructions. The review should flag that gap. Add the real run command and repeat the review. If Claude invents a command unsupported by the project, mark the result as incorrect.
Keep the skill in the project when the same review recurs across changes. Adapt its criteria to your team’s real requirements and have a person review the findings. See the Claude Code overview and our guide to project knowledge in Obsidian.