Rails Documentation Generator

A comprehensive guide for generating and maintaining documentation in Ruby on Rails applications. This skill covers README templates, API documentation with Swagger/OpenAPI, YARD documentation for code, Architecture Decision Records (ADRs), and automated documentation workflows.

Use this skill when

• Creating project README files
• Documenting REST APIs with Swagger/OpenAPI
• Generating code documentation with YARD
• Recording architecture decisions with ADRs
• Setting up automated documentation generation
• Creating developer onboarding documentation
• Documenting deployment procedures
• Creating API changelogs
• Generating database schema documentation
• Creating style guides and conventions
• Documenting background jobs and cron tasks
• Creating troubleshooting guides
• Maintaining migration guides between versions