From f237765e3ddd4bdb3e4438b8dc6fbaf2ef11cfc5 Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Mon, 14 Aug 2023 18:57:12 +0100 Subject: [PATCH 1/2] Updated audience description --- en-US/Audience.xml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/en-US/Audience.xml b/en-US/Audience.xml index 165da34..e387d1b 100644 --- a/en-US/Audience.xml +++ b/en-US/Audience.xml @@ -6,11 +6,15 @@
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. + This guide is the official style guide for Red Hat training and certification content, and for all other technical documentation except as stated. + The guide includes everyday punctuation and grammar, common mistakes to avoid, strategies for translation and global audiences, and a word usage dictionary. - 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. + Red Hat product documentation by Customer Content Services (CCS) follows the Red Hat supplementary style guide at instead of this Red Hat Technical Writing Style Guide. + + Other resources for technical writing are listed in . +
From 5762765f4f9cbab2ddc295a9cb2012b9801df6a9 Mon Sep 17 00:00:00 2001 From: Julian Cable Date: Tue, 15 Aug 2023 11:22:41 +0100 Subject: [PATCH 2/2] Further updated audience wording --- en-US/Audience.xml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/en-US/Audience.xml b/en-US/Audience.xml index e387d1b..4e63d5f 100644 --- a/en-US/Audience.xml +++ b/en-US/Audience.xml @@ -7,10 +7,13 @@ Audience This guide is the official style guide for Red Hat training and certification content, and for all other technical documentation except as stated. - The guide includes everyday punctuation and grammar, common mistakes to avoid, strategies for translation and global audiences, and a word usage dictionary. + Red Hat product documentation by Customer Content Services (CCS) follows the Red Hat supplementary style guide at instead of this Red Hat Technical Writing Style Guide. - Red Hat product documentation by Customer Content Services (CCS) follows the Red Hat supplementary style guide at instead of this Red Hat Technical Writing Style Guide. + The Red Hat Technical Writing Style Guide includes everyday punctuation and grammar, common mistakes to avoid, strategies for translation and global audiences, and a word usage dictionary. + + + This guide is a public guide. It is reviewed and maintained by Red Hat. Contributions from the wider community are always welcomed. Other resources for technical writing are listed in .