Procedures

Key Point: A procedure is a sequence of numbered
steps for accomplishing a task.

Introductory sentences

In most cases, introduce a procedure with an introductory sentence. Don't simply repeat the
heading. This introdutory sentence should provide additional context to the reader. If no context
is needed, you can skip the introductory sentence.

The sentence can end with a colon or a period. Use a colon if it immediately
precedes the procedure. Use a period if there's more material (such as a
note paragraph) between the introduction and the procedure.

Don't introduce a procedure with a partial sentence that's completed by the
numbered steps.

Not recommended: To customize the
buttons:

Recommended: To customize the buttons,
follow these steps:

Single-step procedures

When a procedure consists of just one step, fold the step into the
introductory sentence.

Not recommended:

To clear (flush) the entire log, follow this step:

Click Clear logcat.

Also not recommended:

To clear (flush) the entire log, follow this step:

Click Clear logcat.

Recommended:

To clear (flush) the entire log, click Clear logcat.

Sub-steps in numbered procedures

In a numbered procedure, sub-steps are labeled with lowercase letters, and
sub-sub-steps get lowercase Roman numerals.

When a step has sub-steps, treat the step like an introductory sentence: put a colon or a
period at the end of the step, as appropriate.

Recommended:

First, do foo, as follows:

Do the first part of foo.

Do the second part of foo. There is no third part.

Do the first sub-part of foo part two.

Do the second sub-part of foo part two.

Next, do bar.

Multi-action procedures

In general, use one step per action. However, you can combine small actions
into one step, using arrows (>) for sequential menu selections.

Recommended:

Click Next > Finish.

Also recommended:

Click File > New > Document.

Don't make the
steps too long. If they feel too long, consider splitting them into
multiple steps.

Repetitive procedures

Use concise procedures to avoid repetitiveness and overwhelming the user with too much
bolding of UI elements.

More guidelines for writing procedures

If the user must press Enter after a step, then include that
instruction as part of the step.

Not recommended:

Click the search box in the top-right corner and type custom
function.

Press Enter.

Recommended:

Click the search box in the top-right corner, then type custom
function and press Enter.

State the purpose of the action before stating the action.

Not recommended:

Click File > New > Document to start
a new document.

Recommended:

To start a new document, click File > New >
Document.

State the location of the action before stating the action. If there are multiple
headings associated with a set of procedures, restate the location of
the action in the first step of each procedure, even if the location is the same as in the
previous procedure.

Not recommended:

Click File > New > Document in Google Docs.

Recommended:

In Google Docs, click File > New >
Document.

Don't use "please."

Not recommended:

To open a document, please click File > Open.

Recommended:

To open a document, click File > Open.

For an optional step, type "Optional:" as the first word of the step.

Recommended:

Optional: Type an arbitrary string, to be delivered to the target
address with each notification delivered over this channel.

Use complete sentences.

Use parallel structure.

When there's more than one way to do something, give only the best way.
Giving alternate ways can confuse users.

Don't use directional language to orient the reader, such as above, below, or right-hand
side. This type of language doesn't work well for accessibility or for localization reasons.
If a UI element is hard to find,
provide a screenshot.

Not recommended: In the left-side panel, click the button
with three lines.