docs-audit

Identify undocumented controllers, models, and routes in a Rails codebase.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/Grupo-AFAL/claude-plugins --skill docs-audit-grupo-afal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-audit
Source: https://github.com/Grupo-AFAL/claude-plugins/tree/main/docs-tools/skills/docs-audit
Command: npx skills add https://github.com/Grupo-AFAL/claude-plugins --skill docs-audit-grupo-afal

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Identify gaps between a Rails application's code and its documentation site so teams know which controllers, models, and routes lack user-facing pages and require documentation.

Core Features & Use Cases

  • Resource inventory: Runs or instructs a script to list controllers, models, routes, and existing doc pages to create a baseline.
  • Gap classification: Categorizes missing documentation by priority (high/medium/low) based on user impact and feature type.
  • Actionable report: Produces a prioritized checklist and suggested doc paths so maintainers can approve and start creating pages.
  • Use case: Quickly audit a Rails app before a release to surface undocumented end-user features and prioritize doc work.

Quick Start

Run the docs-audit workflow on the Rails project root to generate a prioritized documentation gaps report.

Frequently Asked Questions about docs-audit

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

FAQPage Schema
How do I find undocumented controllers and models in a Rails codebase?

To find undocumented Rails controllers and models, run a gap audit that inventories application files and resource routes, then compares them against existing documentation pages to produce a prioritized report of missing pages.

What is a documentation gap analysis for Rails routes?

A documentation gap analysis for Rails routes compares your application's resource routes against existing doc pages to detect missing user-facing documentation and categorize those gaps by priority based on user impact and feature type.

Can I audit a Rails project for missing documentation without extra dependencies?

Yes, you can audit Rails documentation without extra dependencies by using a resource script or standard POSIX find and grep commands to inventory controllers, models, routes, and existing doc pages for comparison.

How do I prioritize which Rails features need documentation before a release?

Prioritize Rails feature documentation before a release by running an audit that classifies missing pages into high, medium, and low priority categories based on user impact, generating an actionable checklist of suggested doc paths.

Does the documentation audit work with existing Rails documentation sites?

Yes, the documentation audit works with existing Rails documentation sites by comparing your codebase's controllers, models, and routes against the pages already present on your doc site to identify exactly what is missing.

What is the best way to generate a checklist of missing Rails doc pages?

The best way to generate a checklist of missing Rails doc pages is to run an audit workflow on your project root that inventories all controllers, models, and routes, then outputs a prioritized gap report with suggested documentation paths.