ankane-readme-writer_skill

Overview

This skill creates and updates README files using the Ankane-style template for Ruby gems. Use it to produce concise, actionable docs with strict formatting and sentence limits. It enforces section order, single-purpose code fences, and imperative voice.

How this skill works

Inspect project metadata to populate header and badges. Generate sections in the exact Ankane order and keep sentences under fifteen words. Produce code examples with two-space indentation and one code fence per example. Validate verbs, placeholders, and removal of HTML comments.

When to use it

• Create a README for a new Ruby gem following Ankane style
• Reformat an existing README to match Ankane conventions
• Ensure README sentences stay under fifteen words
• Produce single-purpose code fences and minimal prose
• Add or update header badges and gem metadata

Best practices

• Write in imperative voice for all instructions
• Keep every sentence to fifteen words or fewer
• Organize sections: Header, Installation, Quick Start, Usage, Options, Upgrading, Contributing, License
• Use one code fence per logical example
• Indent code examples with two spaces
• Use inline comments only when necessary and keep them short

Example use cases

• Generate a README for a new gem named <gemname>
• Convert verbose README into a concise Ankane-style document
• Add a Quick Start with a generator command
• Create usage examples: basic and advanced
• Produce an options table with up to ten rows