Software Documentation


© Janice Karin

Lesson 4: Writing Procedures

Use ordered lists

By definition a procedure consists of a set of tasks that need to be performed in a specific order. By presenting these tasks in an ordered list, with steps 1, 2, 3, etc., you reinforce the need to follow a set order. Numbered lists have an ingrained implied order that's almost subconscious and thus provide much stronger impetus that simply supplying paragraphs filled with "Do this then do that" terminology.

Ordered lists also help you bone down the language to its simplest, and thus clearest, form. By removing all of the extraneous connective words needed to indicate order in paragraph form you remove verbiage that could confuse your readers.



Previous Page  1  2  3  4  5  6  7  8   Next Page

Print this Page Print this page