diff --git a/en-US/Design.xml b/en-US/Design.xml index 761543f..a970b4a 100644 --- a/en-US/Design.xml +++ b/en-US/Design.xml @@ -721,6 +721,38 @@ $ vi myFile.txt + +
+ Making Recommendations + + When making a recommendation, the preferred verbiage is "Red Hat recommends..." instead of the common but indirect "It is recommended...". + Recommendations can include best practices, recommended practices, and product-specific suggestions. + Refer to for information on using the terms "best practices" and "recommended practices" in Red Hat documentation. + + + + (incorrect) + + + "Although the attack surface is reduced to the same-project traffic, it is recommended to create multiple service accounts within a project." + + + "It is recommended to generate a service account for each microservice in your project." + + + + + (correct) + + + "Although the attack surface is reduced to the same-project traffic, Red Hat recommends creating multiple service accounts within a project." + + + "Red Hat recommends that you generate a service account for each microservice in your project." + + +
+
Citing Other Works @@ -779,6 +811,7 @@ $ vi myFile.txt
+
Citing Other Authors @@ -794,4 +827,3 @@ $ vi myFile.txt
- diff --git a/en-US/Slang.xml b/en-US/Slang.xml index faf9e4d..f4ec60b 100644 --- a/en-US/Slang.xml +++ b/en-US/Slang.xml @@ -23,8 +23,10 @@ This is a commonly understood phrase, and despite some concerns about using superlatives without statistics to back them up, Red Hat does not actively discourage its use. It is also a more common search term than most alternatives. If you are in any doubt, the preferred alternative is "recommended practices." - - + + See the section for additional information about recommendations in Red Hat documentation. + + @@ -872,4 +874,3 @@ -