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
+18-17Lines changed: 18 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ title: O'Reilly Style Guide
40
40
41
41
<p>For term conventions, check our guide and word list first, then <em>The Chicago Manual of Style</em>, 17th edition, then <em><ahref="https://www.merriam-webster.com">Merriam-Webster’s Collegiate Dictionary</a></em>. Use your book-specific word list (provided by production) to document style choices that differ or are not covered here (e.g., A.M. or a.m., data center or datacenter).</p>
42
42
43
-
<p>To avoid unintentional bias, when writing about groups of people, check the group’s advocacy organization for guidance on appropriate language. The <ahref="https://consciousstyleguide.com">Conscious Style Guide</a> is one good resource, aggregating links to relevant organizations. <strong>The <ahref="https://itconnect.uw.edu/work/inclusive-language-guide">University of Washington has another</a> that is tech-specific.</strong> The <ahref="https://ncdj.org/style-guide">Disability Language Style Guide</a> is a thorough guide to writing about disabilities with sensitivity. Always follow a person’s preference and note exceptions, if necessary (e.g., quoting research that is decades old).</p>
43
+
<p>To avoid unintentional bias, when writing about groups of people, check the group’s advocacy organization for guidance on appropriate language. The <ahref="https://consciousstyleguide.com">Conscious Style Guide</a> is one good resource, aggregating links to relevant organizations. <strong>The <ahref="https://itconnect.uw.edu/work/inclusive-language-guide">University of Washington has another</a> that is tech-specific.</strong> The <strong><ahref="https://ncdj.org/style-guide">Disability Language Style Guide</a></strong> is a thorough guide to writing about disabilities with sensitivity. Always follow a person’s preference and note exceptions, if necessary (e.g., quoting research that is decades old).</p>
44
44
45
45
<p>For questions specific to your book or assignment, please consult with your editor or production editor.</p>
46
46
</section>
@@ -152,7 +152,7 @@ title: O'Reilly Style Guide
152
152
<h3>Citations</h3>
153
153
<p>When citing other materials in bibliographies, reference lists, or footnotes, use the “Notes and Bibliography” system from the <ahref="https://www.chicagomanualofstyle.org/tools_citationguide.html"><em>The Chicago Manual of Style</em></a>, 17th edition. <strong>Chicago also has an Author-Date system that some authors prefer, which is perfectly acceptable. If there is no discernible consistency, suggest Chicago's Notes for footnotes and Bibliography for endnotes or back matter.</strong></p>
154
154
155
-
<p><strong>Let your production editor know which of Chicago's systems you applied by adding a note to the Word List Doc.</strong></p>
155
+
<p>Let your production editor know which of Chicago's systems you applied by adding a note to the Word List Doc.</p>
<p>Every formally numbered figure, table, and example should be preceded by a specific in-text reference (for example: see Figure 99-1; Example 1-99 shows; Table 1-1 lists, etc.). Formal figures, tables, and examples should not be introduced with colons or phrases like “in the following figure,” or “as shown in this table.” Though we do support unnumbered informal figures/tables/examples, these should be used only for elements whose contents are not discussed at length or referred back to. Lack of specific in-text references may cause incorrect placement of figures. <strong>See <ahref="#cross_references">Cross References</a> above for more detail on including cross references.</strong></p>
336
+
<p>Every formally numbered figure, table, and example should be preceded by a specific in-text reference (for example: see Figure 99-1; Example 1-99 shows; Table 1-1 lists, etc.). Formal figures, tables, and examples should not be introduced with colons or phrases like “in the following figure,” or “as shown in this table.” Though we do support unnumbered informal figures/tables/examples, these should be used only for elements whose contents are not discussed at length or referred back to. Lack of specific in-text references may cause incorrect placement of figures. See <ahref="#cross_references">Cross References</a> above for more detail on including cross references.</p>
337
337
338
338
<divdata-type="tip">
339
339
<p>If you are writing or copyediting in Word, figure, table, and example numbers should be numbered as follows: 1-2 (note hyphen [-], not en dash [–] between numbers). The first number is the chapter number. This will be soft-coded in production if not during the writing process.</p>
@@ -745,7 +745,7 @@ title: O'Reilly Style Guide
745
745
<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>
746
746
</li>
747
747
<li>
748
-
<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.<strong>(Copyeditors: please check with your production editor if you wish to suggest global changes to tone.)</strong></p>
748
+
<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>
749
749
</li>
750
750
<li>
751
751
<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>
@@ -803,7 +803,8 @@ title: O'Reilly Style Guide
803
803
</thead>
804
804
<tbody>
805
805
<tr>
806
-
<td><p>Filenames, file extensions (such as .jpeg), directory paths, and libraries.</p></td>
806
+
807
+
<td><p>Filenames, file extensions (such as .jpeg), directory paths, libraries, and commands in Unix, Oracle, and Linux books. <strong>Exception: Python packages (e.g., NumPy, scikit-learn, TensorFlow, etc.) are roman and cased according to convention.</strong></p></td>
807
808
<td><p><em>Body font italic</em></p></td>
808
809
</tr>
809
810
<tr>
@@ -944,7 +945,7 @@ title: O'Reilly Style Guide
944
945
<li>big data</li>
945
946
<li>Big Design Up Front (BDUF)</li>
946
947
<li>bioinformatics</li>
947
-
<li><strong>Bitcoin (capitalize the concept/network/currency in general; lowercase specific units of currency)</strong></li>
948
+
<li>Bitcoin (capitalize the concept/network/currency in general; lowercase specific units of currency)</li>
948
949
<li>bitmap</li>
949
950
<li>bit mask</li>
950
951
<li>Bitnet</li>
@@ -986,7 +987,7 @@ title: O'Reilly Style Guide
986
987
<li>client/server</li>
987
988
<li>client side (n)</li>
988
989
<li>client-side (a)</li>
989
-
<li><strong>cloud native (n or a)</strong></li>
990
+
<li>cloud native (n or a)</li>
990
991
<li>co-class</li>
991
992
<li>coauthor</li>
992
993
<li>codebase</li>
@@ -1093,7 +1094,7 @@ title: O'Reilly Style Guide
1093
1094
<li>fax</li>
1094
1095
<li>file manager</li>
1095
1096
<li>filename</li>
1096
-
<li><strong>filepath</strong></li>
1097
+
<li>filepath</li>
1097
1098
<li>file server</li>
1098
1099
<li>filesystem</li>
1099
1100
<li>file type</li>
@@ -1124,8 +1125,8 @@ title: O'Reilly Style Guide
1124
1125
<li>GHz</li>
1125
1126
<li>gid</li>
1126
1127
<li>GIMP</li>
1127
-
<li><strong>Git</strong></li>
1128
-
<li><strong>GitHub</strong></li>
1128
+
<li>Git</li>
1129
+
<li>GitHub</li>
1129
1130
<li>GNOME</li>
1130
1131
<li>GNU Emacs</li>
1131
1132
<li>GNU Public License (GPL)</li>
@@ -1231,7 +1232,7 @@ title: O'Reilly Style Guide
1231
1232
<li>leftmost</li>
1232
1233
<li>less-than sign or <</li>
1233
1234
<li>leveled (not levelled)</li>
1234
-
<li><strong>life cycle or lifecycle (be consistent)</strong></li>
1235
+
<li>life cycle or lifecycle (be consistent)</li>
1235
1236
<li>line-feed (a)</li>
1236
1237
<li>line feed (n)</li>
1237
1238
<li>Linux</li>
@@ -1249,9 +1250,9 @@ title: O'Reilly Style Guide
1249
1250
1250
1251
<h2id="wordlist-M">M</h2>
1251
1252
<ul>
1252
-
<li><strong>Mac (or MacBook)</strong></li>
1253
+
<li>Mac (or MacBook)</li>
1253
1254
<li>macOS (replaces Mac OS X)</li>
1254
-
<li><strong>machine learning (n and a, no hyphen)</strong></li>
1255
+
<li>machine learning (n and a, no hyphen)</li>
1255
1256
<li>mail-handling (adjective)</li>
1256
1257
<li>– man hours s/b avoided (alternatives: work hours, employee hours)</li>
1257
1258
<li>manpage</li>
@@ -1335,7 +1336,7 @@ title: O'Reilly Style Guide
1335
1336
<li>Oracle Parallel Query Option</li>
1336
1337
<li>O’Reilly Media, Inc.
1337
1338
<ul>
1338
-
<li><strong>O’Reilly’s platform s/b "the O’Reilly platform" or "the O’Reilly learning platform" and then "O’Reilly" on subsequent mentions.</strong></li>
1339
+
<li>O’Reilly’s platform s/b "the O’Reilly platform" or "the O’Reilly learning platform" and then "O’Reilly" on subsequent mentions</li>
1339
1340
</ul>
1340
1341
</li>
1341
1342
<li>OS/2</li>
@@ -1435,7 +1436,7 @@ title: O'Reilly Style Guide
1435
1436
<li>right-click</li>
1436
1437
<li>righthand (a)</li>
1437
1438
<li>rmail</li>
1438
-
<li><strong>road map or roadmap (be consistent)</strong></li>
0 commit comments