readme-crafter
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.
- Choose the appropriate template components from the
- 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.
More from zenless-lab/skills
python-docstring-expert
Expert methodology for evaluating, formatting, and generating Python docstrings. Use when creating or updating documentation for Python code, determining if a docstring is necessary based on API exposure, or formatting docstrings for modules, classes, and functions. Load this skill when code changes affect existing docstrings to keep them synchronized.
17cloud-init-crafter
Expert assistant for creating, modifying, and debugging cloud-init scripts. Supports multiple formats (YAML, shell, MIME archives), Jinja templating with instance-data, and multi-platform validation.
9skill-expert
Comprehensive master guide for designing, creating, editing, updating, and refactoring Agent Skills according to the official agentskills.io specification. Use this when you need to build or modify capabilities for an AI agent.
8agents-md-crafter
Use this skill when you need to create, update, or improve AI agent instruction files like AGENTS.md, GEMINI.md, or copilot-instructions.md. Trigger this anytime the user wants to set up standard AI rules, document project context for LLMs, or add repository-wide guidelines for AI agents.
8skill-crafter
Use this skill when creating a new skill or when modifying, updating, refactoring, restructuring, or reviewing an existing skill. Trigger it for framework-specific and framework-agnostic skill work, including SKILL.md design, folder layout, scripts, references, assets, metadata, and description optimization, even if the user only says "make a skill", "improve this skill", or "refactor the skill".
7secret-scanner
Use this skill when instructed to perform a security scan, find leaked secrets, or check for PII in the codebase or git diffs. Trigger this even if the user broadly asks to check for security issues, leaked credentials, passwords, API tokens, emails, or sensitive data before committing.
7