Skip to content

Commit a74a648

Browse files
authored
Updates on referring to object names and using realistic usernames (#554)
* Updates on referring to object names and using realistic usernames * Apply review comments
1 parent 5ce7b81 commit a74a648

File tree

1 file changed

+52
-6
lines changed

1 file changed

+52
-6
lines changed

en-US/Design.xml

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<title>Capitalization</title>
1717
<para>
1818
The standard for all Red&nbsp;Hat technical documentation is title case for all headings and titles.
19-
Table titles and procedure headings fall into this category; standard title case capitalization rules apply.
19+
Table titles and procedure titles fall into this category; standard title case capitalization rules apply.
2020
</para>
2121
</formalpara>
2222
<para>
@@ -724,8 +724,8 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
724724

725725
</formalpara>
726726
<para>
727-
For example, you are the system administrator at Global Banking and you are asked to set up permissions to the accounting directory for the following users: Huong Sabo, Jerlene Paluch, Abby Quincy, Fricis Ritcher, and Jaya Lamont.
728-
Huong is a department manager and needs read access to the accounting directory. Jerlene is the lead accountant and needs both read and write access.
727+
For example, you are the system administrator at Global Banking and you are asked to set up permissions to the accounting directory for the following users: Huong Sabo, Jolene Paluch, Abby Quincy, Francis Ritcher, and Jaya Lamont.
728+
Huong is a department manager and needs read access to the accounting directory. Jolene is the lead accountant and needs both read and write access.
729729
</para>
730730
<formalpara id="choosing-realistic-names">
731731
<title>Choosing a Realistic Name</title>
@@ -743,17 +743,28 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
743743
In examples or scenarios, you can use a person's name and then use a gender-specific pronoun to refer to that name. Vary the use of proper names in documentation. Use names that represent various ethnic backgrounds, genders, and locations.
744744
</para>
745745

746+
</listitem>
747+
<listitem>
748+
<para>
749+
Include a diverse set of names in your examples to reflect the diversity of the real world.
750+
For example, use gender-inclusive and culturally diverse names that suggest various backgrounds in examples to avoid implying that only certain groups have specific skills.
751+
</para>
752+
746753
</listitem>
747754
<listitem>
748755
<para>
749756
Do not use copyrighted fictional characters in examples, and do not use real people.
750757
</para>
751758

752759
</listitem>
760+
753761
<listitem>
754762
<para>
755-
Include a diverse set of names in your examples to reflect the diversity of the real world.
756-
For example, use male, female, and culturally diverse names that suggest various backgrounds in examples to avoid implying that only certain groups have specific skills.
763+
When choosing names, also consider how those names might appear in email addresses, usernames, and similar contexts.
764+
Avoid name combinations or abbreviations that result in unintended meanings, such as slang.
765+
An example that works well might be "John Smith", with an email address of <email>jsmith@example.com</email>.
766+
However, for the name "Brian Strong", a corresponding email address of <email>bstrong@example.com</email> might not work so well (when read out, it sounds like "be strong").
767+
Consider also any implications for names in different languages.
757768
</para>
758769

759770
</listitem>
@@ -872,7 +883,7 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
872883

873884
</table>
874885
<para>
875-
Place an object name before the noun that it modifies rather than after the noun.
886+
In most cases, place an object name before the noun that it modifies rather than after the noun.
876887
</para>
877888

878889
<table>
@@ -899,6 +910,41 @@ STEP 14: COMMIT <emphasis>...output omitted...</emphasis> localhost/nexus:latest
899910

900911
</tgroup>
901912

913+
</table>
914+
<para>
915+
However, in some cases, the sentence might be easier to understand if the noun appears first, or if additional language separates the object name from the noun.
916+
For example, if the noun refers to a password, a value, or a status, then consider stating the noun first, or including explanatory language between the object name and the noun, or doing both.
917+
</para>
918+
919+
<table>
920+
<title></title>
921+
<tgroup cols="2" colsep="1" rowsep="1">
922+
<colspec colname="c1"></colspec>
923+
<colspec colname="c2"></colspec>
924+
<thead>
925+
<row>
926+
<entry> Example </entry>
927+
<entry> Improvement </entry>
928+
929+
</row>
930+
931+
</thead>
932+
<tbody>
933+
<row>
934+
<entry> Log in as the <systemitem>admin</systemitem> user with the <systemitem>redhat</systemitem> password. </entry>
935+
<entry> Log in as the <systemitem>admin</systemitem> user with <systemitem>redhat</systemitem> as the password. </entry>
936+
937+
</row>
938+
<row>
939+
<entry> Define the <varname>backup_tmp</varname> variable with the <varname>/tmp</varname> value in the <filename>defaults/main.yml</filename> file. </entry>
940+
<entry> Define the <varname>backup_tmp</varname> variable with a value of <varname>/tmp</varname> in the <filename>defaults/main.yml</filename> file. </entry>
941+
942+
</row>
943+
944+
</tbody>
945+
946+
</tgroup>
947+
902948
</table>
903949

904950
</section>

0 commit comments

Comments
 (0)