yard-documentation
CommunityDocument Ruby APIs with precise English YARD docs
Authorigmarin
Version1.0.0
Installs0
System Documentation
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.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: yard-documentation Download link: https://github.com/igmarin/rails-agent-skills/archive/main.zip#yard-documentation Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.