ibm-sg-structure-and-format

Review documentation for IBM Style Guide structure and formatting compliance.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps ensure documentation adheres to the IBM Style Guide's standards for structure and formatting, improving clarity and consistency.

Core Features & Use Cases

  • Structure Review: Checks headings, lists, and procedures for correct hierarchy, formatting, and style.
  • Formatting Compliance: Verifies adherence to guidelines for paragraphs, tables, notes, emphasis, and figures.
  • Use Case: When preparing a document for publication, use this skill to automatically flag any deviations from the IBM Style Guide's rules on sentence case in headings or parallel structure in lists.

Quick Start

Review the provided document for IBM Style Guide structure and format issues.

Frequently Asked Questions about ibm-sg-structure-and-format

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

FAQPage Schema
How do I check my documentation for IBM Style Guide compliance?

To review documentation for IBM Style Guide structure and format issues, submit the document for automated checks against rules for headings, lists, procedures, tables, and emphasis. This flags deviations to ensure stylistic consistency across IBM publications.

What formatting rules does the IBM Style Guide enforce for headings and lists?

IBM Style Guide formatting rules require sentence case in headings and parallel structure in lists. They also mandate correct hierarchy and style for procedures, tables, notes, figures, and emphasis to ensure clarity and consistency.

When do I need to review content against IBM Style Guide structure standards?

Review content against IBM Style Guide structure standards when preparing a document for publication. This verifies that elements like headings, lists, procedures, and tables meet formatting rules prior to release.

Does this approach cover formatting compliance for tables and emphasis?

Yes, formatting compliance covers tables, notes, emphasis, and figures. It verifies adherence to IBM Style Guide guidelines for these elements, ensuring paragraphs and tables maintain the required stylistic consistency.

What is the best way to ensure parallel structure in technical documentation lists?

The best way to ensure parallel structure in technical documentation lists is to review content against the IBM Style Guide. This process flags deviations from the required parallel structure and list formatting rules.