Synopsis of Procedure

Introduction to the procedure. Briefly (!) explain what the procedure accomplishes for the reader.

(By the way, this illustration at right can also be done as an image map, which might be particularly useful if the procedure is one involving physical parts.)

Before you begin:

List any prerequisites or required conditions that must be met before the reader can perform this procedure. If the reader must have specific tools, skills, or permissions, list them like this:

• First requirement
• Second requirement
• Third requirement
• Fourth requirement
• Fifth requirement

For more detailed information on the prerequisites, see the page Prerequisites.

What to do

Introduce the procedure with a one-sentence summary to help the reader form an overview and so that experienced readers can skip the detailed procedure. Then list the steps or phases of the procedure. Make each step listing a link to the page that presents that step in greater detail.

1. First step in the procedure. Each step tells the reader precisely what do.
2. Second step in the procedure. Each step tells the reader precisely what do.
3. Third step in the procedure. Each step tells the reader precisely what do.
4. Fourth step in the procedure. Each step tells the reader precisely what do.
5. Fifth step in the procedure. Each step tells the reader precisely what do.

Results

Briefly discuss the normal, desired results. Tell the reader how to recognize whether the procedure succeeded. If appropriate, link to the results page so the reader can see for him or herself.

Also tell the reader what to do if the procedure fails. Include a paragraph like this:

If the results are not what you expected, jump to the trouble shooting procedure. Or contact us at person@internet.mail.address or at phone_number.