agentleFS
Sign inStart free
joshuadavidthomasjoshuadavidthomas/agent-skills/crafting-effective-readmes/SKILL.md

crafting-effective-readmes

Skill49 starsChanged 6 months agoMITView on GitHub

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

13 other projects use a version of this, 2 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use feedback-mastery, skill-judge and 6 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • nbirknerSkill

    feedback-mastery

    Use when preparing to give difficult feedback, approaching a hard conversation with a direct report, peer, or manager, or navigating conflict at work. Also use before performance reviews or when addressing repeated behavior issues. Keywords: give feedback, hard conversation, conflict, performance issue, SBI framework.

    Also in 3 projects that use this

  • wpankSkill

    skill-judge

    Evaluate Agent Skill quality against official specifications. Use when reviewing SKILL.md files, auditing skill packages, improving skill design, or checking if a skill follows best practices. Provides 8-dimension scoring (120 points) with actionable improvements. Triggers on review skill, evaluate skill, audit skill, improve skill, skill quality, SKILL.md review.

    Also in 3 projects that use this

  • jeasonstudioSkill

    agent-md-refactor

    Refactor bloated AGENTS.md, CLAUDE.md, or similar agent instruction files to follow progressive disclosure principles. Splits monolithic files into organized, linked documentation.

    Also in 3 projects that use this

  • jamesrochabrunSkill

    qa-test-planner

    Generate comprehensive test plans, manual test cases, regression test suites, and bug reports for QA engineers. Includes Figma MCP integration for design validation.

    Also in 3 projects that use this

  • nahisahoSkill

    database-schema-designer

    Copilot agent for database schema design, ER diagrams, normalization, DDL generation, and performance optimization

    Also in 3 projects that use this

  • lookfreeSkill

    excalidraw

    Generate architecture diagrams as .excalidraw files from codebase analysis. Use when the user asks to create architecture diagrams, system diagrams, visualize codebase structure, or generate excalidraw files.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

6 rules. About 0 are common, 5 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read current README, identify stale sections

    line 42
  2. Very specific:

    Check against actual project state (package.json, main files, etc.)

    line 47
  3. Distinctive:

    Update "Last reviewed" date if present

    line 49
  4. Distinctive:

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

    line 53
  5. Distinctive:

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

    line 64
  6. Distinctive:

    Every README needs at minimum:

    line 68

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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?"

TaskWhen
CreatingNew project, no README yet
AddingNeed to document something new
UpdatingCapabilities changed, content is stale
ReviewingChecking 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

TypeAudienceKey SectionsTemplate
Open SourceContributors, users worldwideInstall, Usage, Contributing, Licensetemplates/oss.md
PersonalFuture you, portfolio viewersWhat it does, Tech stack, Learningstemplates/personal.md
InternalTeammates, new hiresSetup, Architecture, Runbookstemplates/internal.md
ConfigFuture you (confused)What's here, Why, How to extend, Gotchastemplates/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

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free