rb:document

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