WritingStyleGuide
WritingStyleGuide copied to clipboard
StyleGuides
The official Red Hat guide to writing clear, concise, and consistent technical documentation.
"But in general I agree with Steve: if commands are complex or important enough (because of their side effects) to belong to separate screens they probably belong to separate substeps...
We should review our guidance to take into account the following from the Corporate guide: capitalization If it's not the official name of a Red Hat offering (with a SKU)...
The Style Guide breaks some of its own rules wrt heading design and layout. e.g., some headings are immediately followed by other headings with no intervening text.
From the Dec Word Nerds meeting: "hardened: New entry has been published. "Hardened" should be avoided as a general descriptor and given context when used (such as "hardened for security")."
Review content from the Corp guide to determine what (if anything) to add to the RHSG. "secure: Draft for security and compliance entries has been approved by Legal & will...
Word Nerds: DRAFT ENTRIES FOR STYLE GUIDE: public cloud (n. or adj.) Always write as two words. Do not hyphenate when used as a complex adjective (public cloud environment). private...
This discussion started around the use "application streams" vs "AppStreams" and "ApplicationStreams" but extends to other objects and concepts such as "deployment configuration" and "DeploymentConfig." ~~~ This issue requires discussion...
The https://stylepedia.net splash page could do with a bit of refurbishment to bring it a bit more in line with other RH pages. I'm not thinking "like the Portal" but...
If we formalize the structure of the Usage Dictionary and make it parseable, we can use it with [Pre-commit](https://pre-commit.com/) and run tests over content to help with adherence to the...
Metadata
Owner
Metadata
The official Red Hat guide to writing clear, concise, and consistent technical documentation.