Documentation style

Documentation style

This section provides resources for Red Hat style and documentation architecture conventions.

Authoring modularly structured documentation

The documentation follows a modular-based content model, providing a structure for writing and presenting user-story-based documentation. User-story-based documentation attempts to address the reader’s needs more than focusing on feature-based documentation. This is accomplished using a set of templates for concepts, references, procedures and assemblies. Templates can be found here.

Red Hat Documentation Asciidoc Mark-up Conventions

Red Hat Ansible Automation Platform documentation is written in Asciidoc. To learn more about using Asciidoc in Red Hat documentation, see Red Hat Documentation Asciidoc Mark-up Conventions.

Red Hat product documentation style conventions

The Red Hat Customer Content Services team uses the Red Hat supplementary style guide for product documentation and The IBM Style Guide as its primary sources for technical writing conventions and style guidelines.

You can access the IBM Style Guide online. The first time you access the online IBM Style Guide, it asks for an IBMid. Enter your Red Hat email. That’s all you need to authenticate. The IBM Style Guide online is easier to navigate and search than the IBM Style Guide PDF in the CCS folder on The Source.

Refer first to the Red Hat supplementary style guide for product documentation for style guidance and conventions. If a topic is not included there, it means we follow the convention as established in the IBM Style Guide. For a checklist of good practices in technical writing, see the IBM Style Guide quick reference.