fundamentals technical writing presentation

How to Write a Technical Manual

(With Me, Mrs. Cannon)

Technical manuals

tell people

how to do all sorts

of things, from

putting together a table to playing games.

To see how a technical manual is written, I will write a technical manual about writing technical

manuals. Let’s get started!

How to Write a Technical Manual

1. Firstly, decide what your technical manual will be about. 2. Jot down each step for the activity you chose.

Be sure to include every step. Be specific about how each step

should be completed.

How to Write a Technical Manual

3. Organize the steps into a logical order.

This way, readers will know what to do when.

If steps are out of order, readers will be unnecessarily confused.

How to Write a Technical Manual

4. Rewrite the steps so each begins with a verb.

Notice that all but one of my steps (the numbered steps, not these side notes) begins with a verb.

If you include extra information (and you should), you can use other sentence openers. (Notice that the sentence before this one begins with an adverb clause, aka www.asia.buuba.)

How to Write a Technical Manual

5. Use clear and concise words. You want readers to understand

each step quickly and easily. Extra words clutter up the page.

6. Include pictures

and graphics. You might

include a picture that illustrates a step.

You might include a graphic that illustrates a point.

Now you have all the right tools to write a technical manual!

6. Include pictures

and graphics. You might

include a picture that illustrates a step.

You might include a graphic that illustrates a point.

Now you have all the right tools to write a technical manual!

My picture of a tool box illustrates this sentence.

That’s all there is to writing a technical manual!

Have questions? Just let me know!