|
1 | 1 | = About this guide |
2 | 2 |
|
3 | | -This guide provides style guidelines and preferred term usage for link:https://www.redhat.com/[Red Hat] product and cross-product solution documentation. It is intended to be used as a supplement to the _IBM Style_ guide, which is the primary source of guidance for Red Hat product documentation. |
| 3 | +The style and language guidance in this guide overrides or supplements some guidance provided by the _IBM Style_ guide, which is the primary source of style guidance for link:https://www.redhat.com/[Red Hat] product and cross-product solution documentation. |
4 | 4 |
|
5 | | -The Red Hat Customer Content Services team created this guide as part of its responsibility for producing product documentation for Red Hat customers. Upstream communities who want to align more closely with the standards used by Red Hat product documentation can also use this guide. |
| 5 | +The Red{nbsp}Hat Customer Content Services team has created this guide to help ensure that Red{nbsp}Hat product documentation is clear, consistent, and cohesive. Upstream communities who want to align more closely with the standards used by Red{nbsp}Hat product documentation can also use this guide. |
6 | 6 |
|
7 | 7 | [NOTE] |
8 | 8 | ==== |
9 | | -Other Red Hat technical documentation, including Red Hat training and exam content by Global Learning Services (GLS), follows the link:https://stylepedia.net/[_Red Hat Technical Writing Style Guide_] instead of the _Red Hat supplementary style guide for product documentation_. |
| 9 | +Other Red Hat technical documentation, including Red Hat training and exam content by Global Learning Services (GLS), follows the link:https://stylepedia.net/[_Red Hat Technical Writing Style Guide_] instead of the _Red{nbsp}Hat supplementary style guide for product documentation_. |
10 | 10 | ==== |
11 | 11 |
|
12 | | -== How to use this guide |
| 12 | +== Using style guides for Red{nbsp}Hat product documentation |
13 | 13 |
|
14 | | -When looking for style guidance, reference this guide first, because it overrides certain guidance from the _IBM Style_ guide. If you must deviate from the guidance in either guide, notify the style council by opening an link:https://github.com/redhat-documentation/doc-style/issues[issue]. This way, the deviation can be discussed by the style council and included in this guide. |
| 14 | +Red{nbsp}Hat product documentation adheres to the style guidance provided in the _IBM Style_ guide, the _Red{nbsp}Hat supplementary style guide for product documentation_, and documentation style guidelines specific to Red{nbsp}Hat products, such as Red{nbsp}Hat Enterprise Linux or Red{nbsp}Hat OpenShift Container Platform. |
15 | 15 |
|
16 | | -== Related Red Hat guides |
| 16 | +When seeking style guidance, consult the style guide specific to your product documentation project first, if applicable, then the _Red{nbsp}Hat supplementary style guide for product documentation_, and finally the _IBM Style_ guide. |
| 17 | +The following image illustrates the hierarchical relationship between the different style guides in Red{nbsp}Hat product documentation: |
17 | 18 |
|
18 | | -In addition to the _IBM Style_ guide and the _Red Hat supplementary style guide for product documentation_, Red Hat product documentation uses the following reference guides for technical writers: |
| 19 | +image:images/ccs-style-guide-hierarchy.png[CCS style guide hierarchy] |
| 20 | + |
| 21 | +If you think that a documentation use case needs to deviate from the guidance in this guide, notify the style council by opening an link:https://github.com/redhat-documentation/doc-style/issues[issue]. This way, the deviation can be discussed by the style council and, if appropriate, included in this guide. |
| 22 | + |
| 23 | +== Related Red{nbsp}Hat guides |
| 24 | + |
| 25 | +In addition to the _IBM Style_ guide and the _Red{nbsp}Hat supplementary style guide for product documentation_, Red{nbsp}Hat product documentation uses the following reference guides for technical writers: |
19 | 26 |
|
20 | 27 | * link:https://redhat-documentation.github.io/modular-docs/[_Modular Documentation Reference Guide_]: Guidance for all things connected to modular documentation, including implementing those guidelines in AsciiDoc. |
21 | 28 | * link:https://redhat-documentation.github.io/asciidoc-markup-conventions/[_AsciiDoc Mark-up Quick Reference_]: Guidance specific to writing in AsciiDoc. Includes links to complete documentation for AsciiDoc and Asciidoctor. |
|
0 commit comments