WritingStyleGuide
WritingStyleGuide copied to clipboard
StyleGuides
The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Would it be possible for all heading levels in the Style Guide to have unique links? For example, I'd like to be able to link directly to section 3.4.4.1, but...
https://stylepedia.net/style/#hyphenation > Hyphenate Consecutive Vowel Sounds A note exists with two exceptions, but they're both cases of consecutive "o" sounds. How about adding "reestablish" as another example of an exception.
https://stylepedia.net/style/#allow-uses Table 4.2 is missing some markup on commands and menus.
The very last entry contains two issues: Avoid use of an acronym if it could stand for more than one term in a single asset. for example, if you are...
To add to https://stylepedia.net/style/#Avoiding_Slang_Metaphors-MisleadingLanguage-Anthropomorphism: Original: "Setting the `nice` value in Linux can adjust the willingness of a process to yield CPU time to other processes." Improvement: "Setting the `nice` value...
Use a nonbreaking space before a numeral in a publication title that denotes part of a sequence in a series of publications. Example: "Refer to the _Red{nbsp}Hat OpenShift Administration{nbsp}II: Operating...
In section 3.4.4.1, Example 3.6. Long Command Example, remove incorrect indentation from the second line. The latest standard is not to use manual line indentation for the second and subsequent...
https://stylepedia.net/style/#referring-punc-special-chars Example 2.5. Referring to Special Characters The hyphen after the greater than symbol (>) indicates that a newline character (\n) is not added to the end of the variable....
https://stylepedia.net/style/#punc-names The RHSG refers to | as the pipe character, but IBM uses "vertical bar". If we're just referring to the character, which should we use? I know it's common...
We have some guidance in IBM, and some in our guide, but we could probably use a dedicated subsection with a table, much as we use for character symbols. The...
Metadata
Owner
Metadata
The official Red Hat guide to writing clear, concise, and consistent technical documentation.