Can I filter out internal Rails components from the audit?

Yes, the skill automatically excludes non-user-facing files such as ApplicationController, concerns, mailers, jobs, and test files to focus on public-facing features.

Does it support MDX files?

Yes, the skill is designed to find and recognize both .md and .mdx files within your project's documentation source folder.

How does docs-audit identify documentation gaps?

It scans your Rails codebase for controllers, models, and routes and compares them against existing files in your documentation directory to identify which features lack corresponding guides.

Does this skill automatically write the missing documentation?

The docs-audit skill focuses on discovery and prioritization. Once gaps are identified and priorities confirmed, you can use the companion /update-docs command to generate the actual content.

What does the priority report include?

The report categorizes gaps into High, Medium, and Low priority based on user impact and documentation complexity, providing a clear roadmap for what to document next.

Rails Documentation Auditor

Name: Rails Documentation Auditor
Author: Grupo-AFAL

byGrupo-AFAL

•

内容管理

Identifies documentation gaps in Rails applications by analyzing codebase resources against existing documentation sites.

The docs-audit skill automates the process of identifying undocumented features in Ruby on Rails applications by cross-referencing controllers, models, and routes with existing Markdown or MDX documentation files. It provides a structured workflow to categorize resources by domain, assess documentation priority based on user impact, and generate comprehensive gap reports. By highlighting missing end-user guides versus technical references, it helps development teams maintain high-quality, up-to-date documentation that evolves alongside the codebase.

主要功能

01Smart exclusion filters for internal components like concerns, mailers, and jobs

02Integration with documentation update workflows for immediate remediation

03Automated Rails resource inventory of controllers, models, and routes

041 GitHub stars

05Cross-reference analysis with Markdown/MDX documentation directories

06Prioritized gap reporting based on feature importance and audience

使用场景

01Maintaining documentation parity during rapid Rails development cycles

02Conducting high-level audits to identify missing end-user guides for new features

03Standardizing documentation coverage across large, multi-namespace Rails applications

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add grupo-afal/claude-plugins docs-audit

For use in Claude.ai and ChatGPT

主要功能

01Smart exclusion filters for internal components like concerns, mailers, and jobs

02Integration with documentation update workflows for immediate remediation

03Automated Rails resource inventory of controllers, models, and routes

041 GitHub stars

05Cross-reference analysis with Markdown/MDX documentation directories

06Prioritized gap reporting based on feature importance and audience

使用场景

01Maintaining documentation parity during rapid Rails development cycles

02Conducting high-level audits to identify missing end-user guides for new features

03Standardizing documentation coverage across large, multi-namespace Rails applications

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add grupo-afal/claude-plugins docs-audit

For use in Claude.ai and ChatGPT