Software Documentation


© Janice Karin

Lesson 4: Writing Procedures

Use short phrases and sentences

It's important to give each instruction as clearly as possible. The fewer words used to convey a particular task, the less places there are for a user to get confused. Anyplace you can use a single word to convey an action, do so.

Avoid any elaboration or explanation within the procedure itself. If you need to provide options or explain why a particular task is important, do it in paragraph form before you begin the procedure. If the user can choose more than one way to perform a specific task, present each procedure separately after explanatory text discussing when that particular option is a good choice.



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

Print this Page Print this page