ruby-docstrings
Installation
SKILL.md
Ruby Docstrings
Use this skill to add or normalize YARD comments in Ruby code so external tools can discover API intent without reverse-engineering the implementation.
Intent Router
| Need | Load |
|---|---|
| preferred syntax, extraction path, and caveats | references/docstrings.md |
Quick Start
- Inspect the repository for an existing documentation convention.
- Preserve an established machine-readable style when it already works with external tooling.
- Otherwise standardize on YARD comments for the requested Ruby surface.
- Document public and externally consumed symbols before private helpers.
- Keep names, parameters, return semantics, and examples aligned with the real code.