Index of every page on this site: llms.txt
All skills
davila7 avatar

/crafting-effective-readmes

@053feb2
Run it yourself

Use when writing or improving README files. Not all READMEs are the same — provides templates and guidance matched to your audience and project type.

Use this Skill: https://skilld.dev/gh/davila7/claude-code-templates/crafting-effective-readmes

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈45 tokens for metadata: the name and description. ≈617 when used: this file. ≈14k more on demand in 13 files.

Description uses 2.2% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈178 characters, or 2.2%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

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:

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

Adding a section:

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

Updating existing content:

  1. What changed?
  2. Read current README, identify stale sections
  3. Propose specific edits

Reviewing/refreshing:

  1. Read current README
  2. Check against actual project state (package.json, main files, etc.)
  3. Flag outdated sections
  4. 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:

  1. Name - Self-explanatory title
  2. Description - What + why in 1-2 sentences
  3. 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

Source: SKILL.md on GitHub

No rule matched.

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning2mo4 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    The skill provides comprehensive templates and guidance for writing, updating, and reviewing project README files tailored to different project types (Open Source, Personal, Internal, Config). It is purely instructional and does not contain any malicious code, dangerous commands, or data exfiltration patterns.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

  • Runlayer9mo

    14/14 files flagged

Signed by skilld at 053feb2. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 10 months ago

README badge

README badge for davila7/claude-code-templates/crafting-effective-readmes