yard-documentation

Enforce English YARD tags and documentation blocks on Ruby public APIs.

22|6|Updated Mar 11, 2026

Search Tags:#documentation #code-quality #ruby #english #api-docs #yard #public-methods

Ready to run

npx skills add https://github.com/igmarin/rails-agent-skills --skill yard-documentation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: yard-documentation
Source: https://github.com/igmarin/rails-agent-skills/tree/main/yard-documentation
Command: npx skills add https://github.com/igmarin/rails-agent-skills --skill yard-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

YARD documentation is essential for clear public APIs in Ruby. This skill ensures consistent, English-language YARD blocks across classes and methods, enabling reliable API docs generation and easier code maintenance.

Core Features & Use Cases

Enforces comprehensive YARD tags on public interfaces, including @param, @return, @raise, and @example.
Mandates English-language descriptions and examples to support global collaboration and tooling.
Provides a post-implementation governance gate and practical examples to guide code reviews.

Quick Start

Document every public Ruby class and method with English YARD tags immediately after implementing changes.

Frequently Asked Questions about yard-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I enforce YARD documentation for Ruby public APIs?▼

YARD documentation for Ruby public APIs is enforced by applying a post-implementation governance gate mandating English-language @param, @return, and @example tags before PR completion. This ensures consistent inline documentation across Rails and Ruby projects.

What YARD tags are required for Ruby public methods?▼

Required YARD tags for Ruby public methods include @param, @return, @raise, and @example blocks. These comprehensive English-language tags ensure clear public interfaces and enable easier code maintenance and reliable API docs generation.

Does YARD documentation work with Rails projects?▼

YARD documentation applies to Rails projects by enforcing consistent English-language YARD blocks across classes and methods. It supports global collaboration and tooling by mandating English descriptions and comprehensive inline documentation for public APIs.

When do I need YARD documentation for Ruby code?▼

YARD documentation for Ruby code is needed when maintaining clear public APIs requiring consistent inline documentation and generated API references. It enables reliable API docs generation and supports global collaboration through English-language descriptions.

What is the best way to document Ruby APIs with YARD?▼

Documenting Ruby APIs with YARD is best done by immediately adding English-language YARD tags to every public class and method after implementing changes, followed by a HARD-GATE check before PR completion to ensure comprehensive @param, @return, and @example blocks.