WritingStyleGuide
WritingStyleGuide copied to clipboard
StyleGuides
The official Red Hat guide to writing clear, concise, and consistent technical documentation.
1-word titles are often hard to understand and can be very difficult to translate. Need a section that highlights this, offers examples (e.g., "Core" in JBoss release notes), includes references...
This is not covered at all, anywhere, afaict. @nmuller66 care to engage? This could possibly go in chapter 5, which looks like it could do with a bit of an...
User feedback: Reading the Stylepedia, my middle-aged eyes have a difficult time on the tight line and letter spacing. The general spacing on the EAP docs (https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.0/html-single/installation_guide/#installing_jboss_eap) are much easier...
Need something to help first-timers get involved; a general process doc that covers the basics.
Was https://bugzilla.redhat.com/show_bug.cgi?id=905707 Nothing left in that bug that prevents us from transferring it here with everything else.
http://stylepedia.net/#sect-Red_Hat_Technical_Publications-Writing_Style_Guide-Grammar-Sentence_Structure The example here is not a good one. "People read" is not a suitable alternative or reconstruction of the original. Table 2.4. Example Improvement The individual member of the...
e.g., "Do not hyphenate a compound that includes an adverb ending in -ly, whether it comes before or after the noun. This is described in Chicago Manual of Style 7.82."...
We often say (e.g.) "Use the one-word form" but it doesn't help if people look up the two-word or hyphenated form and it's not there. It just makes it harder...
From IRC conversation: "Several zones can be grouped into a zonegroup, previously known as a region." trying to work out if "zonegroup" is a formal name, proper noun, or whatever...
The existing entry is brief and doesn't cover many use cases. IBM and AP and CMoS differ in some areas. Need to narrow down the variables.
Metadata
Owner
Metadata
The official Red Hat guide to writing clear, concise, and consistent technical documentation.