rh-ssg-gui-and-links

Check Red Hat documentation for GUI element formatting and link compliance by validating UI element capitalization, interaction verbs, screenshot alt text, cross-reference syntax, and external link rules against the Supplementary Style Guide.

The Red Hat style guide rules for formatting UI elements in technical content require using bold text for UI elements and specific interaction verbs like click, select, or enter to ensure clarity and consistency across documentation.

Format cross-references and external links in Red Hat documentation by following specific SSG rules for cross-reference syntax, external link formatting, Red Hat documentation URL structure, and Knowledgebase article links to ensure compliance.

Yes, the Red Hat style guide requires descriptive alt text for screenshots in documentation. Screenshots must be used judiciously and include descriptive alt text to adhere to the Supplementary Style Guide for graphical interfaces.

You can validate Red Hat documentation URL structure against the style guide by reviewing the content to flag deviations from SSG rules regarding link structure, cross-references, and Knowledgebase article formatting.

Perform a style guide compliance check on Red Hat technical content when reviewing a new documentation page to flag any deviations from the SSG regarding how UI elements are presented or how links are structured.