This skill streamlines the process of maintaining professional Ruby codebases by enforcing strict YARD documentation standards across all public interfaces. It ensures every public method includes mandatory param, return, and raise tags, providing clear contracts for both developers and automated API generation tools. By providing specialized patterns for service objects, complex hash parameters, and exhaustive exception tracking, it helps teams maintain a self-documenting Rails or Ruby application that is easier to navigate, review, and integrate.
주요 기능
0119 GitHub stars
02Multi-exception tracking with individual @raise tags for every possible error
03Automated verification workflows using yard stats and yard doc commands
04Mandatory tag enforcement for public methods including @param, @return, and @raise
05Detailed @option documentation for complex hash-based parameters
06Standardized patterns for Ruby Service Objects and self.call methods
사용 사례
01Ensuring new features meet documentation compliance before the code review stage
02Retrofitting legacy Ruby code with clear, type-safe interface descriptions
03Standardizing API documentation across a Ruby on Rails monolith or engine