diataxis:readme
CommunityCreate README front pages that orient readers.
Authorjayteealao
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Write README front doors that orient readers and route them to deeper docs, without becoming a tutorial or full reference manual.
Core Features & Use Cases
- Creates a concise repository landing page with project name, elevator pitch, audience, and a clear documentation map.
- Guides readers to tutorials, how-tos, references, and explanations as needed.
- Works for open source projects, libraries, and small teams needing a scalable docs homepage.
Quick Start
Generate a README landing page skeleton with sections and a clear map to deeper documentation.
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: diataxis:readme Download link: https://github.com/jayteealao/agent-skills/archive/main.zip#diataxis-readme 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.