docs-review-modular-docs

What problem does it solve?

This Skill automates the review of AsciiDoc files to ensure they adhere to Red Hat's modular documentation standards, catching common errors in structure, naming, and content.

Core Features & Use Cases

• Module Type Validation: Checks if concept, procedure, and reference modules meet specific Red Hat guidelines.
• Structure and Anchor ID Verification: Ensures correct assembly structure and that anchor IDs include the _{context} variable where appropriate.
• Common Violation Detection: Identifies and flags issues like incorrect procedure titles, custom subheadings, or instructions in "Next steps."
• Use Case: A technical writer submits a new procedure module. This Skill is used to verify it follows all Red Hat modular documentation rules before publication.

Quick Start

Use the docs-review-modular-docs skill to review the attached file 'my-module.adoc' for modular documentation compliance.