Skill

crafting-effective-readmes

Guides crafting READMEs with processes and templates for OSS, personal, internal, and config projects matched to audience and task (create, update, review).

documentation

npx claudepluginhub softaworks/agent-toolkit --plugin crafting-effective-readmes

Tool Access

This skill uses the workspace's default tool permissions.

Preview

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.

Supporting Assets

README.mdreferences/art-of-readme.mdreferences/make-a-readme.mdreferences/standard-readme-example-maximal.mdreferences/standard-readme-example-minimal.mdreferences/standard-readme-spec.mdsection-checklist.mdstyle-guide.mdtemplates/internal.mdtemplates/oss.mdtemplates/personal.mdtemplates/xdg-config.mdusing-references.md

SKILL.md

Similar Skills

create-readme

29.8k

Generates well-structured README.md files for projects by reviewing the workspace and using best practices from exemplary open-source repos.

awesome-copilot-refactor

readme-generator

2.0k

Generates README files and technical documentation with step-by-step guidance, best practices, and production-ready markdown. Activates on 'readme generator' or 'readme' phrases.

5 tools

jeremylongshore-claude-code-plugins-plus-skills

slim-readme

Generates customized README.md templates by analyzing repo structure, package.json, pyproject.toml, and Cargo.toml. Use for new projects, doc improvements, open source prep, or onboarding.

1 file

slim-rebranding

Stats

Parent Repo Stars955

Parent Repo Forks70

Last CommitJan 28, 2026

Used By3 plugins

Actions

View Source View Plugin View on GitHub View README

Help us improve

Share bugs, ideas, or general feedback.

Crafting Effective READMEs

Overview

READMEs answer questions your audience will have. Different audiences need different information - a contributor to an OSS project needs different context than future-you opening a config folder.

Always ask: Who will read this, and what do they need to know?

Process

Step 1: Identify the Task

Ask: "What README task are you working on?"

Task	When
Creating	New project, no README yet
Adding	Need to document something new
Updating	Capabilities changed, content is stale
Reviewing	Checking if README is still accurate

Step 2: Task-Specific Questions

Creating initial README:

What type of project? (see Project Types below)
What problem does this solve in one sentence?
What's the quickest path to "it works"?
Anything notable to highlight?

Adding a section:

What needs documenting?
Where should it go in the existing structure?
Who needs this info most?

Updating existing content:

What changed?
Read current README, identify stale sections
Propose specific edits

Reviewing/refreshing:

Read current README
Check against actual project state (package.json, main files, etc.)
Flag outdated sections
Update "Last reviewed" date if present

Step 3: Always Ask

After drafting, ask: "Anything else to highlight or include that I might have missed?"

Project Types

Type	Audience	Key Sections	Template
Open Source	Contributors, users worldwide	Install, Usage, Contributing, License	`templates/oss.md`
Personal	Future you, portfolio viewers	What it does, Tech stack, Learnings	`templates/personal.md`
Internal	Teammates, new hires	Setup, Architecture, Runbooks	`templates/internal.md`
Config	Future you (confused)	What's here, Why, How to extend, Gotchas	`templates/xdg-config.md`

Ask the user if unclear. Don't assume OSS defaults for everything.

Essential Sections (All Types)

Every README needs at minimum:

Name - Self-explanatory title
Description - What + why in 1-2 sentences
Usage - How to use it (examples help)

References

section-checklist.md - Which sections to include by project type
style-guide.md - Common README mistakes and prose guidance
using-references.md - Guide to deeper reference materials