README Crafter
This skill equips the agent with best practices, architectural templates, and modular components to generate modern, high-quality README.md files.
Core Principles
When crafting a README, always adhere to the fundamental rules of clear positioning, cognitive funneling, visual appeal, and practical usage. See Core Principles.
Structure & Architecture
A standard modern README is composed of modular sections: Header, Overview, Features, Getting Started, and Community Support. See README Structure.
Reference Projects
Different projects require different README styles (e.g., comprehensive, visual-driven, architecture-heavy, or personal profile). See Reference Projects to understand which style fits the user's needs.
Workflow / Instructions
- Analyze the Request & Project:
- Determine the project type (CLI, Frontend, Library, Personal Profile, Backend Service). - Identify the target audience (contributors, end-users, recruiters).
- Select Components:
- Choose the appropriate template components from the assets/ directory based on the project type. - For a full out-of-the-box solution, use the complete_modern_template.md. - You can mix and match snippet components to assemble the perfect README.
- Draft the README:
- Write the content. Ensure a strong "Hero Section" (Golden First 3 Seconds). - Keep paragraphs concise (Cognitive Funneling). - Use proper markdown headings, badges, and code blocks.
- Refine and Polish:
- Add placeholders for screenshots, architecture diagrams, or GIFs if applicable. - Include a Table of Contents for longer documents.
Bundled Resources (Assets)
Modular template components to assemble a README. Use these to construct the final output based on user requirements:
Complete Templates
- Complete Modern Template: A beautiful, comprehensive out-of-the-box README template.
- Profile: Template for personal GitHub profile READMEs.
Snippets & Fragments (Plug-and-play)
- Header: Standard: A clean, text-and-badge focused header.
- Header: Visual: A banner/GIF focused header for visual projects.
- Navigation & Features: Table of contents and feature highlights.
- Getting Started: Prerequisites, Installation, and Usage examples.
- Support & Community: Contributing, License, and Acknowledgments.
- Badges Collection: A collection of various markdown badges.
- Architecture Diagram: Examples of using Mermaid for architecture diagrams.
- Contributors & Sponsors: Snippets for showing contributors, backers, and sponsors.