ibm-sg-technical-elements

Review documentation for IBM Style Guide technical element formatting.

Updated Aug 27, 2026

Search Tags:#documentation #technical writing #style guide #code examples #command line #ui elements

Ready to run

npx skills add https://github.com/redhat-documentation/redhat-docs-agent-tools --skill ibm-sg-technical-elements

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: ibm-sg-technical-elements
Source: https://github.com/redhat-documentation/redhat-docs-agent-tools/tree/main/plugins/docs-tools/skills/ibm-sg-technical-elements
Command: npx skills add https://github.com/redhat-documentation/redhat-docs-agent-tools --skill ibm-sg-technical-elements

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures documentation adheres to the IBM Style Guide's specific requirements for technical elements, improving clarity and consistency.

Core Features & Use Cases

Code Example Review: Verifies correct formatting, language tags, and realistic values.
Command Line & Syntax Validation: Checks for proper monospace usage, prompts, line continuation, and syntax notation.
UI & Keyboard Element Formatting: Ensures bolding, capitalization, and interaction verbs align with the style guide.
Use Case: Reviewing a new API reference document to ensure all code snippets, command examples, and UI element references follow the established IBM Style Guide conventions.

Quick Start

Review the provided document for adherence to IBM Style Guide technical element formatting.

Frequently Asked Questions about ibm-sg-technical-elements

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

FAQPage Schema

How do I check documentation for IBM Style Guide technical element formatting?▼

To check documentation for IBM Style Guide technical element formatting, review the text for adherence to code examples, command-line syntax, UI elements, and keyboard key conventions. This validates formatting consistency and improves technical clarity.

What is the correct way to format command line examples and syntax notation?▼

Correct command line formatting requires proper monospace usage, prompts, line continuation, and syntax notation. Reviewing against the IBM Style Guide ensures command examples and syntax notation follow established technical writing conventions.

How do I validate code example formatting and language tags in technical writing?▼

Validating code example formatting involves verifying correct language tags, monospace application, and realistic values. Reviewing documentation against the IBM Style Guide ensures code snippets meet standard technical writing requirements.

Does the IBM Style Guide review cover UI elements and keyboard keys?▼

Yes, the IBM Style Guide review covers UI elements and keyboard keys by checking bolding, capitalization, and interaction verbs. This ensures user interface references align with established style conventions.

What happens when Red Hat SSG guidance conflicts with IBM Style Guide rules?▼

When Red Hat SSG guidance conflicts with IBM Style Guide rules, the Red Hat SSG guidance takes priority. This ensures documentation adheres to specific internal standards while maintaining general technical element consistency.

Can I use this style guide review for API reference documents?▼

Yes, you can use this style guide review for API reference documents to ensure all code snippets, command examples, and UI element references follow IBM Style Guide conventions. It verifies technical elements like web and email addresses.