From docs-skills
Review AsciiDoc (.adoc) files for Red Hat modular documentation compliance — module types (concept, procedure, reference), assembly structure, anchor IDs, context variables, leveloffset, and include directives. Use this skill whenever someone asks about modular docs, checks .adoc file structure, asks if a module is the right type, needs to verify anchor IDs have _{context}, or reviews assemblies. Also triggers for questions about concept vs procedure vs reference modules, prerequisites formatting, or Red Hat doc structure.
How this skill is triggered — by the user, by Claude, or both
Slash command
/docs-skills:docs-review-modular-docsThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Review AsciiDoc source files for Red Hat modular documentation compliance: module types, required sections, anchor IDs, and assembly structure.
Review AsciiDoc source files for Red Hat modular documentation compliance: module types, required sections, anchor IDs, and assembly structure.
Applies to: .adoc files only
For detailed module type guidance, templates, and structural rules, read asciidoc-reference.md. It contains full descriptions of each module type, required/optional parts, templates, and examples.
_{context}_{context}: [#anchor-id_{context}]{product-name}) are defined in the project_{context}.Procedure section present with numbered steps*) not number.Next steps contains links only, not instructions{product-name}) are defined in the project_{context}_{context}: [#anchor-id_{context}]{product-name}) are defined in the project_{context}:context: my-assembly-nameleveloffset= and appropriate level{product-name}) are defined in the project| Issue | Wrong | Correct |
|---|---|---|
| Missing context | [id="my-assembly"] | [id="my-module_{context}"] |
| Standard subheading without anchor ID | == Subheading | [#anchor-id_{context}] then == Subheading |
| Procedure title | = Database Configuration | = Configure the database |
| Custom subheading in procedure | == Additional setup | Use allowed sections only |
| Instructions in Next steps | Numbered steps | Links only |
| Module contains module | include:: of module | Only snippets in modules |
| Missing leveloffset | include::mod.adoc[] | include::mod.adoc[leveloffset=+1] |
| Prerequisite as step | * Install JDK 11 | * JDK 11 is installed. |
| Deep assembly nesting | Many levels of nested assemblies | Link to assemblies instead |
| Writers defining user stories | Writer creates user story | Product management defines user stories |
| Undefined attribute | {my-product} without :my-product: defined | Define in attributes file or document header |
Attribute references use the format {attribute-name}. Common patterns:
{product-name} — product name{product-version} — version number{kebab-case-attr} — multi-word attributes{context} — built-in context variable (always valid)Attributes are defined with the format :attribute-name: value. Check these locations in order:
common-attributes.adocattributes.adoc_attributes.adocattributes/common-attributes.adoc:includedir: or include:: at the topThese AsciiDoc built-ins don't need definition checking:
{doctype}, {backend}, {docname}, {docfile}, {docdir} — document metadata{author}, {email}, {revdate}, {revnumber} — revision infoFile contains: Install {product-name} version {product-version}
✅ Valid if attributes file has:
:product-name: OpenShift sandboxed containers
:product-version: 1.12
❌ Invalid if no definition found — report: "Undefined attributes: {product-name}, {product-version}"
.adoc format_{context} (except assemblies)vale <file> for automated style lintingnpx claudepluginhub opendatahub-io/docs-skills --plugin docs-skillsGuides creation, editing, and verification of skills for AI coding agents using test-driven development with subagent scenarios. Use when authoring or debugging skills.