rh-ssg-formatting

Review Red Hat documentation for Supplementary Style Guide formatting compliance.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/redhat-documentation/redhat-docs-agent-tools --skill rh-ssg-formatting
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rh-ssg-formatting
Source: https://github.com/redhat-documentation/redhat-docs-agent-tools/tree/main/plugins/docs-tools/skills/rh-ssg-formatting
Command: npx skills add https://github.com/redhat-documentation/redhat-docs-agent-tools --skill rh-ssg-formatting

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps ensure that Red Hat documentation adheres to the strict formatting and style guidelines outlined in the Red Hat Supplementary Style Guide, preventing common errors and improving consistency.

Core Features & Use Cases

  • Code Block Formatting: Verifies that commands, inputs, and outputs are correctly formatted within code blocks.
  • User-Replaced Values: Checks that placeholders for user-specific information use the correct syntax (e.g., <value>).
  • Title and Product Naming: Ensures titles use sentence-style capitalization and product names/versions are referenced via attributes.
  • Date and Man Page Formatting: Validates standard date formats and man page reference syntax.
  • Use Case: Before publishing a new article, use this Skill to automatically scan it for any deviations from the Red Hat SSG, such as incorrect use of bolding in code blocks or improper formatting of user-replaceable values.

Quick Start

Review the formatting of the attached document for SSG compliance.

Frequently Asked Questions about rh-ssg-formatting

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

FAQPage Schema
How do I check Red Hat documentation for Supplementary Style Guide compliance?

Reviewing Red Hat documentation for SSG compliance involves scanning text to verify code block formatting, user-replaced value syntax like `<value>`, sentence-style title capitalization, product name attributes, standard date formats, and correct man page references.

What formatting rules does the Red Hat Supplementary Style Guide cover?

The Red Hat Supplementary Style Guide formatting rules cover code block syntax, user-replaced values, sentence-style title capitalization, product name attributes, standard date formats, and man page reference syntax to ensure clarity and consistency in publications.

How do I format user-replaced values in Red Hat documentation?

To format user-replaced values in Red Hat documentation, use the correct placeholder syntax such as `<value>` to indicate user-specific information, ensuring placeholders are properly validated against SSG rules during content review.

Can I automatically scan articles for Red Hat SSG deviations before publishing?

Yes, you can automatically scan articles for Red Hat SSG deviations before publishing by validating the attached document, which detects issues like incorrect bolding in code blocks or improperly formatted user-replaceable values.

How do I validate product name attributes and title capitalization in Red Hat docs?

To validate product name attributes and title capitalization in Red Hat docs, review the text to ensure product names and versions are referenced via attributes and titles strictly use sentence-style capitalization according to SSG requirements.