Topics
- Documentation
- readme
- templates
- open-source
- contributing
- project-setup
- technical-writing
What it does
This skill guides you through writing or updating README files by identifying your audience and task type, then providing templates and section checklists matched to whether you're documenting an open source project, internal tool, personal project, or config folder.
Generated from the current SKILL.md.
Frequently asked
Does this skill work for all project types?
Yes. The skill includes templates and guidance for open source, personal projects, internal tools, and config folders. Ask the skill which project type you're working on if it's not clear.
Can this skill help update an existing README?
Yes. The skill can identify stale sections by comparing your README to the actual project state (package.json, main files, etc.) and propose specific edits.
Does this skill provide templates?
Yes. It includes templates for OSS projects, personal projects, internal tools, and config folders, plus a section checklist and style guide.
What if I'm not sure what type of README I'm writing?
The skill asks you to identify your audience first — contributors, teammates, future you, or portfolio viewers — and matches guidance to that audience rather than assuming defaults.
Generated from the current SKILL.md. These answers refresh after source changes.
