skills.rest
Yassimba
YassimbaCOMMUNITY
Explore all skills by this author →
GitHub

write-readme

Write and update README files using templates matched to project type and audience.

9|Updated Jul 17, 2026
Search Tags:#templates#documentation#writing#markdown#open source#readme#project documentation
One-click install
npx skills add https://github.com/Yassimba/loom --skill write-readme-yassimba
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-readme
Source: https://github.com/Yassimba/loom/tree/main/skills/write-readme
Command: npx skills add https://github.com/Yassimba/loom --skill write-readme-yassimba

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? READMEs often miss the mark because different audiences need different information — an open-source contributor needs install and contributing sections, while future-you opening a config folder needs gotchas and extension notes. This Skill guides the creation, updating, and review of READMEs so the content matches the actual project type and reader. ## Core Features & Use Cases - Task-based workflow: Handles four README tasks — creating, adding a section, updating stale content, and reviewing accuracy against the actual project state. - Project-type templates: Provides ready-to-use templates for open source, personal, internal/team, and config-directory projects, each with the right sections. - Quality references: Includes a section checklist, style guide, and curated references (Art of README, Make a README, Standard Readme spec) for deeper guidance. - Use Case: You just built a Node.js CLI tool and need documentation. The Skill asks about your audience, applies the open-source template, and drafts a README with installation, usage examples, contributing, and license sections. ## Quick Start Use the write-readme skill to create a README for my new open-source CLI project.

Frequently Asked Questions about write-readme

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write a good README for my project?▼

Start by identifying your project type and audience, then include the essential sections: name, a one-to-two sentence description, and usage examples. This Skill provides templates for open source, personal, internal, and config projects with the right sections for each.

What sections should a README have?▼

Every README needs a name, description, and usage section at minimum. Open source projects should add installation, contributing, and license; internal projects need setup, architecture, and runbooks; config directories need a what's-here table and gotchas.

How do I update an outdated README?▼

Read the current README and compare it against the actual project state, such as package.json and main source files. Flag stale sections, propose specific edits for what changed, and update any last-reviewed date if present.

What are common README mistakes to avoid?▼

The most common mistakes are missing installation steps, no usage examples, walls of text without headers or lists, stale content, and a generic tone that ignores the actual audience. Never assume setup is obvious to readers.

Is there a standard README format specification?▼

Yes, the Standard Readme specification defines required and optional sections with exact ordering for open source libraries. This Skill includes the full spec plus minimal and maximal compliant examples in its references directory.

Related Skills

Explore More Content & Communication Skills→
Greenmamba29Greenmamba29

readme-writer

Generate comprehensive README.md files by analyzing codebase structure and dependencies.

Community
Intermediate
DevayoshaUSDevayoshaUS
41

documentation-templates

Provides templates and structure guidelines for README, API docs, changelogs, and AI-friendly documentation.

Community
Basic
mpazarynampazaryna
1

anti-slop

Enforce a human-sounding prose style guide banning LLM clichés and filler phrases.

Community
Basic
dimsourdimsour
2

document

Generate XML doc comments, READMEs, and OpenAPI descriptions from .NET source code.

Community
Advanced