skills.rest
redhat-documentation
redhat-documentationOFFICIAL
Explore all skills by this author →
WebsiteGitHub

docs-review-modular-docs

Review AsciiDoc files for Red Hat modular documentation compliance.

Updated Aug 27, 2026
Search Tags:#documentation#compliance#review#asciidoc#red hat#modular docs
One-click install
npx skills add https://github.com/redhat-documentation/redhat-docs-agent-tools --skill docs-review-modular-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-review-modular-docs
Source: https://github.com/redhat-documentation/redhat-docs-agent-tools/tree/main/plugins/docs-tools/skills/docs-review-modular-docs
Command: npx skills add https://github.com/redhat-documentation/redhat-docs-agent-tools --skill docs-review-modular-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about docs-review-modular-docs

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

FAQPage Schema
How do I review AsciiDoc files for Red Hat modular documentation compliance?▼

Modular documentation compliance checks AsciiDoc (.adoc) files against Red Hat standards for concept, procedure, reference, and assembly modules, verifying anchor IDs, leveloffset, and include directives.

What are the structural requirements for Red Hat concept, procedure, and reference modules?▼

Red Hat concept, procedure, and reference modules require correct module type structure, proper titles, and anchor IDs containing the _{context} variable to meet compliance standards.

How do I validate assembly structure and anchor IDs in .adoc files?▼

Validating assembly structure and anchor IDs in .adoc files involves verifying correct include directives and ensuring anchor IDs include the _{context} variable where appropriate.

Can I check my AsciiDoc procedure module for common modular docs violations?▼

Checking AsciiDoc procedure modules for common violations identifies incorrect procedure titles, custom subheadings, or misplaced instructions in Next steps sections before publication.

Does this modular docs review work with all AsciiDoc files?▼

This modular docs review applies specifically to .adoc files triggered by requests concerning modular docs, module types, anchor IDs, or assembly reviews.

Related Skills

Explore More Content & Communication Skills→
hyperbolic-chyperbolic-c
5

paper-writer

Generate IMRAD manuscript sections with inline citations from content points and references.

Community
Intermediate
cuiosscuioss
1

cui-documentation

Enforce CUI documentation standards for README, AsciiDoc, and technical docs.

Community
Intermediate
mkobitmkobit
3

Technical writing

Enforce ventilated prose and concise writing standards in Markdown and AsciiDoc files.

Community
Basic
kazunori279kazunori279
32

docs-lint

Automate documentation review for broken links and MkDocs compliance.

Community
Advanced