WritingStyleGuide
WritingStyleGuide copied to clipboard
StyleGuides
The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Initial question from @nmuller66 Do we have the guidance about avoiding object names in headings documented anywhere? Examples: Virt-Launcher Pods PersistentVolumes PersistentVolumeClaims Initial suggestion from @daobrien I'd hazard a guess...
Some modern GUIs use icons and buttons that cannot be easily described or recognised (cf `Save` and `Open` and similar) and neither do they have a tooltip or other help...
Word nerds: acronyms & abbreviations - updated with more info, and added to the corporate style guide Things we should add to this entry: - Acrobot (get instructions from David...
Having consistent and succinct instructions, especially stem sentences, can make it easier for both writers, editors, translators, and learners. Fewer decisions to make about sentence construction and terminology, less editing,...
Taken from chat: "I take the extra precaution of hiding "real" IDs and accounts from things such as screenshots, for example when we use an AWS enviroment. For example, in...
NB: this is a low priority request, and is related to #161 The style guide uses `` elements for each of the listed terms. I'd like to introduce suitable icons...
The term "Docker" is only used once in the Style Guide. We need to elaborate on when it is correct and incorrect to do so. We can draw from internal...
Accordion is used by GLS and seems to be pretty common. IBM uses "twistie" for the same thing, but I've never heard of it. Need to come up with something...
should the following be added? Do not use POC or in cases where it is allowed to indicate? POC is a well known, publicly used acronym. It may be prudent...
The Corp (internal) guide has updated info on using bulleted lists. Need to sync this to this version.
Metadata
Owner
Metadata
The official Red Hat guide to writing clear, concise, and consistent technical documentation.