skills.rest
ejoliet
ejolietCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

readme-driven-dev

Generate tailored READMEs from user intent for spec, build-package, and OSS contexts.

Updated Apr 16, 2026
Search Tags:#templates#documentation#tooling#readme#mcp#readme-driven
One-click install
npx skills add https://github.com/ejoliet/claude-skills --skill readme-driven-dev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-driven-dev
Source: https://github.com/ejoliet/claude-skills/tree/main/readme-driven-dev
Command: npx skills add https://github.com/ejoliet/claude-skills --skill readme-driven-dev

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Generates tailored READMEs from user intent to eliminate documentation bottlenecks.

Core Features & Use Cases

  • Type-aware README generation for spec, build-package, and OSS variants
  • Reference-driven templates and best-practice sections (header, purpose, architecture, prerequisites, installation)
  • Open-question tracking and scaffolding to drive production-ready documentation with minimal back-and-forth
  • Consistent multi-platform guidance and example usage tailored to the selected stack

Quick Start

Describe your tool's goals and required type, and this skill will output a complete, ready-to-use README-driven plan.

Frequently Asked Questions about readme-driven-dev

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

FAQPage Schema
How do I generate a production-grade README for an MCP server?▼

To generate a production-grade README for an MCP server, describe your tool's goals and required type to auto-generate tailored documentation including architecture guidance, prerequisites, and deployment notes.

What is README-driven development and how does it eliminate documentation bottlenecks?▼

README-driven development generates tailored documentation from user intent to eliminate bottlenecks, providing reference-driven templates and best-practice sections for spec, build-package, and OSS contexts.

Can I use auto-generated templates for different OSS and build-package documentation contexts?▼

Yes, you can use auto-generated templates for different contexts by specifying your required type, which outputs tailored READMEs with consistent multi-platform guidance and example usage for your selected stack.

What's the best way to scaffold architecture guidance and deployment notes for tools?▼

The best way to scaffold architecture guidance and deployment notes is providing your tool's goals, which triggers reference-driven templates that satisfy mandatory sections required for production-grade documentation.

Do I need to provide specific tooling details to get consistent multi-platform guidance in my README?▼

You need to describe your tool's goals and selected stack to receive consistent multi-platform guidance, as the generated README provides example usage tailored to the specific tooling guidance you require.

Related Skills

Explore More Software Engineering Skills→
caobingshengcaobingsheng
1

vue2-component-type-system

Generate JSDoc, .d.ts, and README templates for Vue2 component APIs.

Community
Advanced
NammDevNammDev
2

mcp-builder

Build scalable MCP servers with Python or TypeScript SDKs.

Community
Advanced
ydnikolaevydnikolaev
8

mcp-expert

Design and configure MCP servers in Go-based projects.

Community
Advanced
sandgardenhqsandgardenhq
130

markdown-navigation

Generate hierarchical outlines and extract sections from markdown files using bash utilities.

Official
Basic