WritingStyleGuide
WritingStyleGuide copied to clipboard
StyleGuides
The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Example 3.2. Preferred Approach to Starting Applications from the Desktop To start gedit, press the Super key to enter the Activities Overview, type gedit, and then press Enter. In the...
The RHT Style Guide forbids using “Overview” in heading titles (in one section), but then uses "Overview" in a good example of a title that uses a noun phrase (in...
https://stylepedia.net/style/6.2/#n Includes an entry for "navigate to". This has been discussed more than once in the past and is now in direct conflict with IBM: navigate verb Use only when...
From @rclee33: The RHT style guide says to write "lifecycle" as one word (https://stylepedia.net/style/6.2/#l). However, several product names use the 2-word form: "Red Hat Enterprise Linux Extended Life Cycle Support...
It's currently not clear (or is easy to miss) that we do not use nbsp with other companies' names. Refer to thread for more details.
https://stylepedia.net/style/6.2/#punc-names The pipe character is not listed.
https://stylepedia.net/style/6.2/#avoiding-ambiguities Table 4.7. The following is given as an example: Tab through the dialog box. Set the tab. Move the tab on the ruler. How to show or hide tabs....
Current entry: check Avoid. Use "verify", "ensure", or "read", depending on the context. Maybe: Avoid if an alternative verb such as "verify", "ensure", or "read" fits in the context. Instead...
Add to guide: When naming an object, avoid duplicating the object's class in its name. Use the noun that follows the object name to indicate its class. Example to avoid:...
The current word usage entry for "dialog box" should be removed because it refers to an entry for that term in IBM Style that no longer exists (IBM removed that...
Metadata
Owner
Metadata
The official Red Hat guide to writing clear, concise, and consistent technical documentation.