skills.rest
slbug
slbugCOMMUNITY
Explore all skills by this author →
GitHub

rb:document

Generate YARD/RDoc documentation and ADRs for Ruby, Rails, and Grape codebases.

7|Updated Mar 22, 2026
Search Tags:#documentation#adr#readme#ruby#yard#rdoc
One-click install
npx skills add https://github.com/slbug/claude-ruby-grape-rails --skill rb-document
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rb:document
Source: https://github.com/slbug/claude-ruby-grape-rails/tree/main/plugins/ruby-grape-rails/skills/document
Command: npx skills add https://github.com/slbug/claude-ruby-grape-rails --skill rb-document

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Many Ruby/Rails/Grape features are implemented without synchronized documentation, leaving public APIs, README sections, and architectural rationales incomplete or missing; this skill closes that gap by identifying new code and generating or updating the required docs. It preserves existing documentation, enforces documentation standards, and ensures design decisions are captured as ADRs so future maintainers understand the why behind changes.

Core Features & Use Cases

  • Identify new modules and files introduced on the current branch or referenced by a plan file and avoid no-op runs when only modifications occur.
  • Check and generate YARD/RDoc coverage for public classes, modules, and methods, filling missing docstrings with templates.
  • Update README sections for user-facing features and create ADRs for significant architectural decisions such as new auth mechanisms or external dependencies.
  • Write structured documentation reports to the plan area for traceability and reviewer handoff.

Quick Start

Invoke the skill with a plan file or feature name like: /rb:document .claude/plans/magic-link-auth/plan.md

Frequently Asked Questions about rb:document

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

FAQPage Schema
How do I generate Ruby documentation for newly added modules and methods?▼

To generate Ruby documentation, the skill scans new .rb files on the current branch or from a plan file, checks YARD and RDoc coverage, and fills missing docstrings with standard templates for public classes and methods.

How do I automatically update a README when adding new features to a Rails project?▼

Updating a README for new Rails features is handled by identifying user-facing changes and automatically generating or appending relevant README sections to reflect the newly implemented functionality.

When do I need to write an Architecture Decision Record for a Ruby codebase?▼

Writing an Architecture Decision Record (ADR) is needed when introducing significant changes like new authentication mechanisms or external dependencies, ensuring the architectural rationale is captured for future maintainers.

Does this documentation tool work with both Grape and Rails codebases?▼

Yes, the documentation generation applies to Ruby, Rails, and Grape codebases, targeting newly added files and features to produce class docs, method docs, README sections, and ADRs.

How do I document existing Ruby methods without overwriting current YARD docstrings?▼

The skill preserves existing documentation by performing pre-checks on YARD and RDoc coverage, ensuring it only generates missing doc templates and avoids overwriting already documented public methods.

Related Skills

Explore More Software Engineering Skills→
slbugslbug
7

rb:secrets

Detect leaked secrets and exposed credentials in Ruby codebases.

Community
Intermediate
fascarifascari

reviewing-code

Review code against project rules and write findings to a markdown file.

Community
Advanced
mlbrightmlbright

tdd-red-agent

Generate failing RSpec tests for the RED phase of TDD in Rails 8.1.

Community
Intermediate
alexfalkowskialexfalkowski
2

ruby-standards

Standardize Ruby API design, RDoc documentation, and test suite integration.

Community
Intermediate