rh-ssg-structure
OfficialEnsure Red Hat docs meet SSG standards.
Content & Communication#documentation#content review#style guide#prerequisites#ssg#admonitions#red hat
Authorredhat-documentation
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps ensure that Red Hat documentation adheres to the Supplementary Style Guide (SSG) by automatically reviewing content for structural compliance, including admonition usage, prerequisite formatting, and short description quality.
Core Features & Use Cases
- Admonition Review: Checks for correct types (NOTE, IMPORTANT, WARNING, TIP), avoids clustering, and ensures modules don't start with admonitions.
- Lead-in Sentence Check: Verifies the appropriate use and clarity of sentences following headings like "Prerequisites" or "Procedure".
- Prerequisite Formatting: Ensures prerequisites are stated as completed states, not imperative commands, and use parallel language.
- Short Description Validation: Confirms modules have concise, customer-centric 2-3 sentence abstracts.
- Use Case: A technical writer can use this skill to quickly scan a newly written module to catch common structural errors before publishing, ensuring consistency and adherence to Red Hat's style guidelines.
Quick Start
Review the structure of the changed content for SSG compliance.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: rh-ssg-structure Download link: https://github.com/redhat-documentation/redhat-docs-agent-tools/archive/main.zip#rh-ssg-structure Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.