Clarify and condense project documentation into structured templates with real examples.
npx skills add https://github.com/vmvarela/skills --skill pragmatic-docs
Please help me install this Agent Skill. Skill: pragmatic-docs Source: https://github.com/vmvarela/skills/tree/main/skills/pragmatic-docs Command: npx skills add https://github.com/vmvarela/skills --skill pragmatic-docs
Pragmatic Documentation helps teams produce clear, useful project documentation (READMEs, guides, docs/) that respects readers' time by focusing on real examples, decisive guidance, and honest limitations.
Create a concise README that presents the big idea, shows a real example, and notes trade-offs in one short page.
High-intent search queries and answers about installing and using this skill.
Concise project documentation starts with The Big Idea in 1-3 paragraphs, integrates real examples like commands and code, and honestly notes trade-offs to respect readers' time.
A README should explain why a project exists by presenting The Big Idea: what the project is, why it was created, and who the target audience is within a few paragraphs.
Structure CONTRIBUTING.md by weaving real command examples and code outputs into the narrative, then acknowledging constraints and providing actionable guidance regarding trade-offs.
Yes, this documentation approach works for READMEs, module docs, CONTRIBUTING.md, and architecture docs by enforcing The Big Idea, real examples, trade-offs, and a single-sentence Quick Start.
You should document trade-offs and limitations in software docs to be honest about constraints, providing actionable guidance so readers understand boundaries rather than expecting perfection.
wizactParse GitHub issues and project documentation to generate context.json files.
copilot-ldRender Markdown documentation into static HTML sites with Mustache templates.
KrystianYCSilvaCreate Markdown documentation with Mermaid diagrams and GFM tables.
zenobi-usAutomate API documentation creation and maintenance with OpenAPI integration.
