pragmatic-docs
CommunityConcise, effective project docs.
Content & Communication#documentation#communication#readme#contributing#examples#pragmatic#module-docs
Authorvmvarela
Version1.0.0
Installs0
System Documentation
What problem does it solve?
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.
Core Features & Use Cases
- Start with The Big Idea: present what the project is, why it exists, and who it's for in 1–3 paragraphs.
- Integrate real examples: weave commands, code, and outputs into the narrative to demonstrate usage.
- Be honest about trade-offs and limitations: acknowledge constraints and provide actionable guidance.
Quick Start
Create a concise README that presents the big idea, shows a real example, and notes trade-offs in one short page.
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: pragmatic-docs Download link: https://github.com/vmvarela/skills/archive/main.zip#pragmatic-docs 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.