Technical Writing Tip:
Include prerequisite steps

Be sure to list all steps and other requirements users need to perform before they do the task you are documenting:

• If a user needs certain tools to perform a task, list them at the beginning of a procedure.
• If a user needs to perform other procedures before starting the one you are documenting, list which procedures need to be done. You can provide cross-references to the page where those procedures are described.
• If a user needs to have certain skills or have a certain job title in order to perform a task, this also needs to be listed. (For example, "This task should be performed only by the network administrator.")

Related Topics

Technical Writing Tips

Writing

Creative Writing Tips

Communication Tips

Links

Orange County STC