O'Reilly logo

Read Me First!: A Style Guide for the Computer Industry, Second Edition by Sun Technical Publications

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Examples

EXAMPLE 2-1

Standard Table

EXAMPLE 2-2

Horizontal Lines Table

EXAMPLE 2-3

Horizontal and Vertical Lines Table

EXAMPLE 2-4

Side and Top Headings Table

EXAMPLE 2-5

Two-Column Table

EXAMPLE 2-6

Error Message Formatting as Text

EXAMPLE 2-7

Error Message Table

EXAMPLE 4-1

Organizing Text by Hierarchy

EXAMPLE 4-2

Organizing Text by Inverted Pyramid

EXAMPLE 4-3

Organizing Text by Table

EXAMPLE 4-4

Organizing by Clickable Flow Diagram

EXAMPLE 4-5

Organizing a Complex Task by Flow Diagram

EXAMPLE 4-6

Organizing Text by Task Map

EXAMPLE 4-7

Writing Clearly and Simply

EXAMPLE 4-8

Keeping Paragraphs Short

EXAMPLE 4-9

Using a Bulleted List

EXAMPLE 4-10

Using a Jump List

EXAMPLE 4-11

Using a Jump List With Annotations

EXAMPLE 4-12

Preserving Context in Online Documents

EXAMPLE 5-1

Preventing ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required