writing-readmes
CommunityCraft clear, usable package READMEs.
AuthorJacobLey
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Every published package needs a readable README that serves two audiences: developers who need to understand what it does and how to use it, and AI agents that require precise API details. This skill provides a concise, actionable framework to create and maintain READMEs that are consistent across a monorepo.
Core Features & Use Cases
- Standard README structure templates covering install, usage, API, and cross-package references.
- Guidance on differentiating README content from WHY files, including when to create WHY-<PACKAGE>.md.
- Rules for updating READMEs to reflect API changes and new features, ensuring consistency and ease of maintenance.
Quick Start
Draft a concise, developer-focused README for a new package that clearly communicates the purpose, usage, and API details.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: writing-readmes Download link: https://github.com/JacobLey/leyman/archive/main.zip#writing-readmes Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.