Loading...
Loading...
Found 5 Skills
Guide for creating effective internal technical documentation (READMEs, ADRs, Contribution Guides). Use this skill when the user asks to write, refactor, or improve internal project documentation.
[Hyper] Create or refactor a project README.md by carefully reading the codebase. Detects project shape (CLI, library, web app, monorepo, plugin, framework, docs site, service), entry points, scripts, configuration, license, and existing docs, then produces a structured README in the project's primary documentation language. Use when the user wants a new README, a refactor of a stale README, or a section update grounded in the actual code.
Write Markdown that people actually read — READMEs, docs, PR bodies, issue bodies and comments, release notes, changelogs. Covers GitHub-flavored extras (alerts, collapsible sections, task lists, mermaid), prose that leads with the point instead of burying it, and a README skeleton.
Documentation best practices — README structure, inline code comments, API docs, changelogs, and technical writing principles. Reference when writing any documentation.
Technical documentation patterns for READMEs, ADRs, API docs (OpenAPI 3.1), changelogs, and writing style guides. Use when creating project documentation, writing architecture decisions, documenting APIs, or maintaining changelogs.