diff --git a/en-US/Audience.xml b/en-US/Audience.xml new file mode 100644 index 0000000..165da34 --- /dev/null +++ b/en-US/Audience.xml @@ -0,0 +1,16 @@ + + +%BOOK_ENTITIES; +]> +
+ Audience + + This guide is the official style guide for technical documentation for Red Hat training and certification content, including how to write for global audiences and translation, common mistakes to avoid, rules for everyday punctuation, and grammar. + + + Other Red Hat technical documentation, including product documentation by Customer Content Services (CCS), follows the Red Hat supplementary style guide for product documentation at instead of this Red Hat Technical Writing Style Guide. + + +
+ diff --git a/en-US/L.xml b/en-US/L.xml index 996b2d7..07c969b 100644 --- a/en-US/L.xml +++ b/en-US/L.xml @@ -105,7 +105,7 @@ - lifecycle + like Avoid "like" to mean "such as". diff --git a/en-US/New.xml b/en-US/New.xml index 9a1a58e..b9c953f 100644 --- a/en-US/New.xml +++ b/en-US/New.xml @@ -5,6 +5,105 @@ ]>
New in This Release + + Release 6.0 + Major update in October 2022 to add further style and grammar guidance: + + + + Added audience information for this guide. + + + Avoid redundant words. + + + Avoid a causative verb. + + + Words to use with countable nouns. + + + Use of "either-or" construction. + + + Avoid stating that something is easy to do or to use. + + + Avoid first person. + + + Use "following" with a noun. + + + Avoid hyphenating with an "-ly" prefix: added an example. + + + If-Then statements. + + + Make a full lead-in sentence to introduce a list. + + + Making list items parallel. + + + Updated guidance about use of compact lists. + + + Using noun strings. + + + Avoid a noun followed by an "-ing" word. + + + Using object names. + + + Placement of "only". + + + Preposition at the end of a sentence. + + + Use straight rather than curly quotation marks. + + + Avoid "(s)" for plural. + + + Added further examples of slang, idioms, and metaphors to avoid. + + + Avoid a slash. + + + Spacing with a unit of measurement. + + + Improved succinctness examples. + + + Avoid "there is", "there are". + + + Use "this", "that", "these", "those" with a noun. + + + Replaced use of "$" as a variable marker in this guide to use angle brackets instead. + + + Use of "whether" versus "if". + + + New or updated usage entries: like, once, while. + + + Various other fixes. + + + + + Release 5.1 Minor update in January 2022 to address some reported issues: diff --git a/en-US/Preface.xml b/en-US/Preface.xml index 37932d5..ebd2ae4 100644 --- a/en-US/Preface.xml +++ b/en-US/Preface.xml @@ -5,6 +5,9 @@ ]> Preface + + +