StyleGuides / WritingStyleGuide

The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Creative Commons Attribution Share Alike 4.0 International
73 stars 20 forks source link

Remove explicit examples for AP Style #578

Closed julian-cable closed 4 months ago

julian-cable commented 5 months ago

Given that this guide is directed at a technical writing audience, remove explicit examples for AP Style, which is more directed at a marketing audience. This feedback comes from Ashley d'Andrea, who noted that the Usage Dictionary entry for "GB" lists both "2GB" and "2 GB" for usage. It would increase clarity to provide just one example.

From Rachel Lee: "I agree about removing the reference to AP style, which is not elsewhere documented as a reference of record. In general, I prefer providing explicit guidance over having readers select a reference and then interpret the guidance. Providing explicit guidance reduces inconsistencies and misalignment."