You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: styleguide/index.md
+15-28Lines changed: 15 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ title: O'Reilly Style Guide
43
43
44
44
<p>To avoid unintentional bias, when writing about groups of people, check the group’s advocacy organization for guidance on appropriate language. O’Reilly aims to avoid the following problematic language and recommends using resources such as the <ahref="https://consciousstyleguide.com">Conscious Style Guide</a>, the <ahref="https://itconnect.uw.edu/work/inclusive-language-guide">University of Washington’s “IT Inclusive Language Guide”</a>, and the <ahref="https://ncdj.org/style-guide">Disability Language Style Guide</a> for alternatives.
45
45
46
-
<p>Avoid language that is unintentionally gendered (e.g., middleman, man hours), violent (e.g., hit, kill), and otherwise exclusionary, incendiary, or inaccurate (e.g., crazy, dummy, master/slave, tribe). Avoid associating positive or negative characteristics with colors that are also associated, problematically, with people (blackbox, black hat, white list, etc.). Always follow a person’s preference and note exceptions, if necessary (e.g., quoting research that is decades old or technology that has fallen behind the times).</p>
46
+
<p>Avoid language that is unnecessarily gendered (e.g., middleman, man hours), violent (e.g., hit, kill), and otherwise exclusionary, incendiary, or imprecise (e.g., crazy, dummy, master/slave, tribe). Avoid associating positive or negative characteristics with colors that are also associated, problematically, with people (blackbox, black hat, white list, etc.). Always follow a person’s preference and note exceptions, if necessary (e.g., quoting research that is decades old or technology that has fallen behind the times).</p>
47
47
48
48
<p>For questions specific to your book or assignment, please consult with your editor or production editor.</p>
49
49
</section>
@@ -355,7 +355,7 @@ title: O'Reilly Style Guide
355
355
<li><p>Use a numeral if it’s an actual value (e.g., 5% 7″ $6.00).</p>
356
356
</li>
357
357
<li><p>Whole numbers one through nine followed by hundred, thousand, million, billion, and so forth are usually spelled out (except in the sciences or with monetary amounts).</p>
358
-
<li>
358
+
</li>
359
359
</ul>
360
360
361
361
<p>This is how we format dates and other numbers:</p>
@@ -783,32 +783,19 @@ title: O'Reilly Style Guide
783
783
<h1>Miscellaneous</h1>
784
784
785
785
<ul>
786
-
<li><p>Do not use a hyphen between an adverb and the word it modifies. So, “incredibly wide table” rather than “incredibly-wide table.”</p>
787
-
</li>
788
-
<li><p>Close up words with the following prefixes (unless part of a proper noun) “micro,” “meta,” “multi,” “pseudo,” “re,” “non,” “sub,” and "co" (e.g., “multiusers,” “pseudoattribute,” “nonprogrammer,” “subprocess,” "coauthor"). Exceptions are noted in the word list (e.g., "re-create," "re-identification").</p>
789
-
</li>
790
-
<li><p>Avoid using the possessive case for singular nouns ending in “s,” if possible. So, it’s “the Windows Start menu,” not “Windows’s Start menu.”</p>
791
-
</li>
792
-
<li><p>Avoid wholesale changes to the author’s voice—for example, changing the first-person plural (the royal “we”) to the first-person singular or the second person. However, do try to maintain a consistency within sentences or paragraphs, where appropriate.</p>
793
-
</li>
794
-
<li><p>We advise using a conversational, user-friendly tone that assumes the reader is intelligent but doesn’t have this particular knowledge yet—like an experienced colleague onboarding a new hire. First-person pronouns, contractions, and active verbs are all encouraged. (Copyeditors: please check with your production editor if you wish to suggest global changes to tone.)</p>
795
-
</li>
796
-
<li><p>Companies are always singular. So, for example, “Apple emphasizes the value of aesthetics in its product line. Consequently, it dominates the digital-music market” is correct. “Apple emphasize the value of aesthetics in their product line. They dominate the digital-music market” is <em>not</em>. (Also applies to generic terms “organization,” “team,” “group,” etc.)</p>
797
-
</li>
798
-
<li><p>When referring to software elements or labels, always capitalize words that are capitalized on screen. Put quotes around any multiword element names that are lowercase or mixed case on screen and would thus be hard to distinguish from the rest of the text (e.g., Click “Don’t select object until rendered” only if necessary.)</p>
799
-
</li>
800
-
<li><p>Use “between” for two items, “among” for three or more. Use “each other” for two, “one another” for three or more.</p>
801
-
</li>
802
-
<li><p>Use the American spellings of words when they differ.</p>
803
-
</li>
804
-
<li><p>Common foreign terms (such as “en masse”) are roman.</p>
805
-
</li>
806
-
<li><p>Introduce unnumbered code blocks with colons.</p>
807
-
</li>
808
-
<li><p>Do not stack admonitions, sidebars, or headings.</p>
809
-
</li>
810
-
<li><p>Avoid obscenities and slurs, and obscure if included (grawlix, a two-em dash, etc.)</p>
811
-
</li>
786
+
<li><p>Avoid obscenities and slurs, and obscure if included (grawlix, a two-em dash, etc.)</p></li>
787
+
<li><p>Avoid using the possessive case for singular nouns ending in “s,” if possible. So, it’s “the Windows Start menu,” not “Windows’s Start menu.”</p></li>
788
+
<li><p>Avoid wholesale changes to the author’s voice—for example, changing the first-person plural (the royal “we”) to the first-person singular or the second person. However, do try to maintain a consistency within sentences or paragraphs, where appropriate.</p></li>
789
+
<li><p>Close up words with the following prefixes (unless part of a proper noun) “micro,” “meta,” “multi,” “pseudo,” “re,” “non,” “sub,” and "co" (e.g., “multiusers,” “pseudoattribute,” “nonprogrammer,” “subprocess,” "coauthor"). Exceptions are noted in the word list (e.g., "re-create," "re-identification").</p></li>
790
+
<li><p>Common foreign terms (such as “en masse”) are roman.</p></li>
791
+
<li><p>Companies are always singular. So, for example, “Apple emphasizes the value of aesthetics in its product line. Consequently, it dominates the digital-music market” is correct. “Apple emphasize the value of aesthetics in their product line. They dominate the digital-music market” is <em>not</em>. (Also applies to generic terms “organization,” “team,” “group,” etc.)</p></li>
792
+
<li><p>Do not stack admonitions, sidebars, or headings.</p></li>
793
+
<li><p>Do not use a hyphen between an adverb and the word it modifies. So, “incredibly wide table” rather than “incredibly-wide table.”</p></li>
794
+
<li><p>Introduce unnumbered code blocks with colons.</p></li>
795
+
<li><p>Use “between” for two items, “among” for three or more. Use “each other” for two, “one another” for three or more.</p></li>
796
+
<li><p>Use the American spellings of words when they differ.</p></li>
797
+
<li><p>We advise using a conversational, user-friendly tone that assumes the reader is intelligent but doesn’t have this particular knowledge yet—like an experienced colleague onboarding a new hire. First-person pronouns, contractions, and active verbs are all encouraged. (Copyeditors: please check with your production editor if you wish to suggest global changes to tone.)</p></li>
798
+
<li><p>When referring to software elements or labels, always capitalize words that are capitalized on screen. Put quotes around any multiword element names that are lowercase or mixed case on screen and would thus be hard to distinguish from the rest of the text (e.g., Click “Don’t select object until rendered” only if necessary.)</p></li>
0 commit comments