WritingStyleGuide
WritingStyleGuide copied to clipboard
StyleGuides
The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Use guidance from IBM and Corporate Guide a a starting point.
The guide cautions against excessive and non-descriptive cross-references and over-reliance on cross-references, but it does not say when cross-references are expected. I am wondering (a) whether it is all right...
https://bugzilla.redhat.com/show_bug.cgi?id=1019258 https://mojo.redhat.com/people/lnovich/blog/2014/07/01/flesh-kinkaid-readability-and-your-documents-this-is-the-number-that-matters A range of info from Laura that needs to be incorporated.
From the Word Nerds meeting Feb 2022: mode 1 / mode 2 / legacy - New entry for “legacy” has been published, as well as updates to “mode 1/mode 2”...
The current TOC is all over the place, with different heading designs used in different places. This has been in my backlog for quite a while but I've never had...
Many parts of the style guide content do not conform to its own guidance. Review the content and correct or improve it as needed. Running Vale can help to a...
This is not covered well (at all?). Need to make it easy for people to determine how and when to use non-breaking spaces. Maybe an entry in the Usage Dictionary...
https://stylepedia.net/style/5.1/#punc-names The layout of table 2.7 is not great. It's not terrible, but I think it could be better. Please offer suggestions. @StyleGuides/style-guide-committers @PatSharp99
Hi, I'd like some clarification on SI unit usage... in the past we all knew the Megabytes really meant 1024 not 1000, can we use KiB, MiB, GiB across the...
Metadata
Owner
Metadata
The official Red Hat guide to writing clear, concise, and consistent technical documentation.