Chicago Manual of Style — Publishing Standards for Technical Documentation

In this tutorial, you will learn about Chicago Manual of Style. We cover key concepts, practical examples, and best practices to help you master this topic.

The Chicago Manual of Style is the standard for American English publishing. While not designed specifically for technical writing, its rules for punctuation, citations, tables, and formal writing apply to reference documentation, white papers, and published technical content.

In this lesson, you will learn which CMS rules apply to technical writing and when to use them.

What You'll Learn

You will understand Chicago Manual of Style rules relevant to technical documentation, apply its punctuation and citation standards, and know when to use CMS versus other guides.

Why It Matters

For formal technical content like white papers, academic publications, and enterprise documentation, CMS provides authoritative guidance that other guides defer to.

Real-World Use

DodaTech uses CMS for the DodaZIP technical white paper and formal reference documentation. Its citation and table formatting rules ensure professional presentation.

flowchart LR
  A[Chicago Manual] --> B[Punctuation]
  A --> C[Tables]
  A --> D[Quotations]
  A --> E[Capitalization]
  B --> F[Serial Comma]
  B --> G[Em Dashes]
  C --> H[Column Headers]
  D --> I[Block Quotes]
  A:::current
  classDef current fill:#f90,color:#fff,stroke:#333,stroke-width:2px

Key CMS Rules for Technical Writing

Use the serial comma also called Oxford comma before and in a list. Compress, decompress, and verify is correct.

Use em dashes without spaces for parenthetical phrases. Compression which uses streaming is fast becomes Compression uses streaming and is fast.

Use en dashes for number ranges. For Python 3.9 to 3.13 write Python 3.9-3.13.

Capitalize proper nouns and product names. Use DodaZIP not dodazip at the start of a sentence.

# CMS: Serial Comma
- Good: Install, configure, and verify.
- Bad: Install, configure and verify.

# CMS: Em Dashes
- Good: Streaming compression processes files block by block. This approach uses less memory than bulk compression.
- Bad: Streaming compression--which processes files block by block--uses less memory.

Tables and Data Presentation

Use clear column headers with capitalization. Header rows should be bold or visually distinct.

Align numbers on the decimal point in columns. This makes comparisons easier.

Use consistent units within a column. Do not mix KB and MB in the same column.

Include source notes below tables for data from external sources.

# CMS: Table Formatting

| Algorithm | Speed (MB/s) | Ratio | Memory (MB) |
|-----------|-------------|-------|-------------|
| Gzip      | 125         | 0.35  | 64          |
| Bzip2     | 45          | 0.28  | 256         |
| XZ        | 12          | 0.22  | 512         |

Source: Benchmarked on Intel i7-13700K with 32 GB RAM using a 1 GB text file.

Common Mistakes

1. No Serial Comma

Compress, decompress and verify could be read as compress, decompress-and-verify.

2. Wrong Dash Type

Using hyphens for number ranges. Python 3.9-3.13 needs an en dash, not a hyphen.

3. Inconsistent Table Alignment

Numbers left-aligned instead of decimal-aligned in columns.

4. Improper Quotation Format

Using straight quotes instead of curly quotes in published content.

5. Over-Capitalization

Capitalizing common nouns like installation or configuration that should be lowercase.

6. Missing Source Attribution

Tables and data from external sources without attribution.

7. Spacing After Periods

Using two spaces after periods (typewriter habit). CMS recommends one space.

Practice Questions

1. What is the serial comma rule?

Use a comma before and in a list of three or more items. Compress, decompress, and verify.

2. When should you use an en dash?

For number ranges, date ranges, and compound adjectives. Python 3.9-3.13.

3. How should numbers be aligned in table columns?

On the decimal point for numeric columns. This makes values easy to compare.

4. What is the proper spacing after periods?

One space. Two spaces is a typewriter convention that CMS no longer recommends.

5. Challenge: Find a table in technical documentation that violates CMS rules. Identify the violations and reformat the table correctly.

FAQ

Mini Project

Take a page of formal technical content. Audit it against Chicago Manual of Style rules for punctuation, capitalization, and table formatting. Identify five violations and correct them.

What's Next

Next: Markdown Style Guide