Engineering Advanced READMEDocumentationDX

README Generator

Generate README files that explain setup, usage, architecture, workflows, and contribution details with developer-friendly structure.

A README-writing skill that optimizes for fast orientation and accurate onboarding instead of template filler. It extracts real commands and workflows from the repository, writes quickstarts that get readers to first success, and flags what belongs in deeper docs instead of the root README.

Added Apr 12, 2026

$npx skills add johnefemer/skillfish --skill readme-generator

Capabilities Get Started Models & Context Works Great With

What This Skill Can Do

Concrete capabilities you get when you install this skill.

Produce audience-specific README structure for apps, libraries, CLIs, and services

Extract accurate install, run, test, and build commands from repository facts

Write quickstarts that minimize time to first success

Summarize architecture, configuration, and contribution workflow clearly

Flag missing documentation that should live outside the README

Tighten README copy for scanability and developer trust

Get Started

How to install and use this skill in your preferred environment.

Skills are designed for AI coding agents (Claude Code, Cursor, Windsurf) and IDE-based workflows where the agent can read files, run scripts, and act on your codebase.

Models & Context

Which AI models and context windows work best with this skill.

Recommended Models

Works well with any frontier model. Best results come from giving the model actual package scripts, entry points, and runtime requirements.

Context Window

SKILL.md is concise (~3KB). Fits in 32K context; richer READMEs improve when representative config and script files are also in context.

Pro tips for best results

1

Be specific

Include numbers — users, budget, RPS — so the skill can size the architecture.

2

Share constraints

Compliance needs, team size, and existing stack all improve the output.

3

Iterate

Start with a high-level design, then ask follow-ups for IaC, cost analysis, or security review.

4

Combine skills

Pair with companion skills below for end-to-end coverage.

Works Great With

These skills complement README Generator for end-to-end coverage. Install them together for better results.

Technical Writer

Technical writing: style guides, API documentation standards, user guides, release notes, knowledge base articles, and developer-facing content with code examples.

Technical WritingStyle Guide

Documentation Engineer

Technical documentation: docs-as-code workflows, API documentation (OpenAPI, AsyncAPI), architecture decision records, Docusaurus/MkDocs setup, and info architecture.

DocumentationDocs-as-Code

Codebase Onboarding

Auto-generate onboarding docs from codebase analysis.

OnboardingDocumentation

Changelog Generator

Generate structured changelogs from conventional commits.

ChangelogReleases

$ skillfish add johnefemer/skillfish --all # install all skills at once

Ready to try README Generator?

Install the skill and start getting expert-level guidance in your workflow — any agent, any IDE.