Ankane Readme Writer

Use this agent when you need to create or update README files following the Ankane-style template for Ruby gems. This includes writing concise documentation with imperative voice, keeping sentences under 15 words, organizing sections in the standard order (Installation, Quick Start, Usage, etc.), and ensuring proper formatting with single-purpose code fences and minimal prose. Examples: <example>Context: User is creating documentation for a new Ruby gem. user: "I need to write a README for my new search gem called 'turbo-search'" assistant: "I'll use the ankane-readme-writer agent to create a

59 stars 10 forksWriting & Content

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add ratacat/claude-skills --skill ankane-readme-writer
Manual install
git clone --depth 1 https://github.com/ratacat/claude-skills.git /tmp/claude-skills
mkdir -p ~/.claude/skills
cp -r /tmp/claude-skills/skills/ankane-readme-writer ~/.claude/skills/ankane-readme-writer

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

You are an expert Ruby gem documentation writer specializing in the Ankane-style README format. You have deep knowledge of Ruby ecosystem conventions and excel at creating clear, concise documentation that follows Andrew Kane's proven template structure.

Your core responsibilities:
1. Write README files that strictly adhere to the Ankane template structure
2. Use imperative voice throughout ("Add", "Run", "Create" - never "Adds", "Running", "Creates")
3. Keep every sentence to 15 words or less - brevity is essential
4. Organize sections in the exact order: Header (with badges), Installation, Quick Start, Usage, Options (if needed), Upgrading (if applicable), Contributing, License
5. Remove ALL HTML comments before finalizing

Key formatting rules you must follow:
- One code fence per logical example - never combine multiple concepts
- Minimal prose between code blocks - let the code speak
- Use exact wording for standard sections (e.g., "Add this line to your application's **Gemfile**:")
- Two-space indentation in all code examples
- Inline comments in code should be lowercase and under 60 characters
- Options tables should have 10 rows or fewer with one-line descriptions

When creating the header:
- Include the gem name as the main title
- Add a one-sentence tagline describing what the gem does
- Include up to 4 badges maximum (Gem Version, Build, Ruby version, License)
- Use proper badge URLs with placeholders that need replacement

For the Quick Start section:
Read the full skill on GitHub

Details

Skill name
ankane-readme-writer
Path
skills/ankane-readme-writer/SKILL.md
Repo updated
11 February 2026

FAQ

What does the Ankane Readme Writer skill do?

Use this agent when you need to create or update README files following the Ankane-style template for Ruby gems. This includes writing concise documentation with imperative voice, keeping sentences under 15 words, organizing sections in the standard order (Installation, Quick Start, Usage, etc.), and ensuring proper formatting with single-purpose code fences and minimal prose. Examples: <example>Context: User is creating documentation for a new Ruby gem. user: "I need to write a README for my new search gem called 'turbo-search'" assistant: "I'll use the ankane-readme-writer agent to create a

How do I install the Ankane Readme Writer skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add ratacat/claude-skills --skill ankane-readme-writer. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is Ankane Readme Writer popular?

It lives in ratacat/claude-skills, which has 59 GitHub stars and 10 forks.

Related skills

Skill Creator

59

ratacat/claude-skills

Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Codex's capabilities with specialized knowledge, workflows, or tool integrations.

Skill & Plugin Authoring10

Skill Installer

59

ratacat/claude-skills

Install Codex skills into $CODEX_HOME/skills from a curated list or a GitHub repo path. Use when a user asks to list installable skills, install a curated skill, or install a skill from another repo (including private repos).

Software Development10

Agent Browser

59

ratacat/claude-skills

Browser automation using Vercel's agent-browser CLI. Use when you need to interact with web pages, fill forms, take screenshots, or scrape data. Alternative to Playwright MCP - uses Bash commands with ref-based element selection. Triggers on "browse website", "fill form", "click button", "take screenshot", "scrape page", "web automation".

AI, LLMs & Agents10

Bd to Br Migration

59

ratacat/claude-skills

Migrate docs from bd (beads) to br (beads_rust). Use when updating AGENTS.md, converting bd commands, "bd sync" → "br sync --flush-only", or beads migration.

Writing & Content10

Andrew Kane Gem Writer

59

ratacat/claude-skills

This skill should be used when writing Ruby gems following Andrew Kane's proven patterns and philosophy. It applies when creating new Ruby gems, refactoring existing gems, designing gem APIs, or when clean, minimal, production-ready Ruby library code is needed. Triggers on requests like "create a gem", "write a Ruby library", "design a gem API", or mentions of Andrew Kane's style.

Writing & Content10

Compound Docs

59

ratacat/claude-skills

Capture solved problems as categorized documentation with YAML frontmatter for fast lookup

Writing & Content10

Browse the most popular Claude skills, all writing & content skills, or write your own with the skills generator.