Generate standardized READMEs for packages in monorepos and multi-package projects.
npx skills add https://github.com/JacobLey/leyman --skill writing-readmes
Please help me install this Agent Skill. Skill: writing-readmes Source: https://github.com/JacobLey/leyman/tree/main/.claude/skills/writing-readmes Command: npx skills add https://github.com/JacobLey/leyman --skill writing-readmes
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.
Draft a concise, developer-focused README for a new package that clearly communicates the purpose, usage, and API details.
High-intent search queries and answers about installing and using this skill.
To structure a package README, use a standard template covering install, usage, API details, and cross-package references. This ensures consistency and readability for both developers and AI agents across monorepos and multi-package projects.
A README explains what a package does and how to use it, while a WHY file documents the architectural decisions. You should create a WHY-<PACKAGE>.md file to separate design rationale from actionable API and usage documentation.
To maintain markdown documentation across a monorepo, apply standard README structure guidelines and update files whenever API changes or new features occur. This enforces consistency and eases maintenance across all published packages.
You should update a package README whenever there are API changes or new features. Keeping documentation aligned with the codebase ensures the structure, usage, and maintenance rules remain accurate for developers and AI agents.
Yes, this README template works for multi-package projects. It provides a concise, actionable framework to standardize documentation, including cross-package references, ensuring consistency across all packages in a monorepo environment.
kslhunterAutomates README updates for packages in the `packages/` directory based on git commit history and diffs.
parisgroup-aiAudit and standardize README and AGENTS documentation across monorepo packages.
adolfoaranaes12Create Architecture Decision Records with context, alternatives, rationale, and consequences.
ZeroGravitySkin-RonStandardize TypeScript shared types, Zod schemas, and utilities across monorepo packages.
