WritingStyleGuide
WritingStyleGuide copied to clipboard
StyleGuides
The official Red Hat guide to writing clear, concise, and consistent technical documentation.
From the Word Nerds meeting: military-grade security This description is used only when discussing government or military security requirements. Do not use to describe generic security or to emphasize security....
For Release 5.2: Some sections in chapter 4 do not align well with the chapter title, "Choosing Appropriate Language". From an initial analysis, sections 4.4 and 4.7-4.9 should be moved...
This is really old and needs fixing. Refer to https://github.com/RedHatTraining/skeleton/discussions/355 and also https://stylepedia.net/docbook/4.0/#using-references for info.
When we create rules in Vale we need to make sure that they're based on solid guidance, and that we can refer writers to this guidance for more info. `allow.yml`...
Add labels to indicate which category of the style guide an issue relates to. Suggested labels: - Grammar - Style - Design - Terms
Discussed in The Editor's Guild chat, 4 November 2022.  Reorganize these headings, possibly into a single section.
Review and update guidance about documenting icons. Discussed in The Editor's Guild chat, 4 November 2022.  The IBM Style standard is to place the icon after "the \...
Currently this only refers (obliquely) to introductions to products, but the topic actually applies to introductions in general.
I don't know that there is any formal rule about this but rather general consensus among editors and IDs not to write titles as questions except in FAQs and similar....
Review section titles in the light of some inconsistency between them. Some are tersely worded, such as 2.10 "Tense", while others in chapter 3 use the wording "Using xxx correctly",...
Metadata
Owner
Metadata
The official Red Hat guide to writing clear, concise, and consistent technical documentation.