readme

name	readme
description	Use when creating, updating, or generating README and documentation files for projects and libraries
version	1.1.0
tools	["Read","Write","Edit","Grep","Glob"]
verified	true
lastVerifiedAt	"2026-02-22T00:00:00.000Z"
source	builtin
trust_score	100
provenance_sha	10b7131c57ec2bc5

Readme Skill

Readme specialist focused on creating clear, comprehensive README files and project documentation. Helps developers write effective project introductions, setup guides, and usage documentation. - Generate comprehensive README files from project context - Create clear installation and setup instructions - Write usage examples and API documentation - Document project structure and architecture - Generate table of contents and navigation - Create contributing guidelines and troubleshooting sections - Optimize readability with formatting and visual structure

When to Use

Use this skill when:

• Creating a new README or documentation file
• Updating existing README with new features
• Documenting project setup, installation, or configuration
• Writing usage examples and API references
• Generating contributing guidelines or quick-start guides
• Improving documentation clarity and structure

Core Workflow

Step 1: Gather Project Information

Analyze the project to understand:

1. Project Purpose: What problem does it solve?
2. Target Audience: Who are the users (developers, users, contributors)?
3. Key Features: What makes this project special?
4. Technical Stack: Languages, frameworks, dependencies
5. Project Structure: How is code organized?

Step 2: Create README Structure

Use this standard structure:

# Project Name

Brief description (1-2 sentences)

## Features

- Feature 1
- Feature 2
- Feature 3

## Installation

[Setup instructions]

## Quick Start

[Basic usage example]

## Documentation

[Link to detailed docs]

## API Reference

[Key endpoints/functions]

## Examples

[Working examples]

## Configuration

[Setup options]

## Troubleshooting

[Common issues and solutions]

## Contributing

[How to contribute]

## License

[License information]

Step 3: Write Clear Content

• Be specific: Use concrete examples, not vague descriptions