The official Red Hat guide to writing clear, concise, and consistent technical documentation.
Full Changelog: https://github.com/StyleGuides/WritingStyleGuide/compare/v6.1...v6.2
Full Changelog: https://github.com/StyleGuides/WritingStyleGuide/compare/v6.0...v6.1
Full Changelog: https://github.com/StyleGuides/WritingStyleGuide/compare/v5.1...v6.0
Full Changelog: https://github.com/StyleGuides/WritingStyleGuide/compare/v5.0...v5.1
Changed guide title to “Red Hat Technical Writing Style Guide”. Changed subtitle to “Style Conventions for Writers and Editors”.
Added inclusive language guidance. Added section on use of relative pronoun “that”. Added sections on exclamation points and referring to punctuation marks. Clarified that sentence case is required for captions, legends, and diagram labels. Added section on phrasal verbs (two-word verb forms). Added more categories of ambiguities to avoid. Dates and Times: Changed times of day standard from “a.m.”, “p.m.” to “AM”, “PM”. Usage A-Z added entries: appendixes, as long as, blacklist, colocate/colocation, display, following, i.e., indexes, login/log in/log in to, master, sign in/sign in to, slave, whitelist, wish Updated entries: backwards-compatible, high-availability, hostname, lifecycle, OK, please, setup, username, ZIP Code Removed guidance about DocBook and markup, to focus instead on writing. Minor edits so the guide itself conforms more fully with its own advice.
Updates to section on using line continuation characters and PS2 prompts, including indentation. New and updated entries to Usage Dictionary. Update section on option and argument terminology.
Addresses a range of issues covered in https://github.com/StyleGuides/WritingStyleGuide/pull/204
The Red Hat Style Guide and Word Usage Dictionary is a joint effort by various groups within Red Hat. This major release addresses a number of issues ranging from typos to addressing changes in best practices and word usage to revised practices for documenting commands and syntax. We've also included access to the Red Hat Training DocBook XML Guide which, while specific to the requirements of the Red Hat Training team, may prove useful to others who need a simple but robust model for their DocBook authoring requirements.