O'Reilly logo

The Insider's Guide to Technical Writing by Krista Van Laan

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Easy as 1, 2, 3: Writing Procedures

At some point—probably early—in your tech-writing career, you’ll be expected to write procedures, numbered steps that guide a user through a process. If you’ve followed a recipe or assembled furniture or bought something online, you’ve worked with procedures.

Writing procedures is a lot harder than following them! All the practices described in this book will come together as you create good procedures. When you finish writing step 1, you have to immediately follow it with step 2. Did you use excess words? Cut them out. Any unclear terms? Change them. Any possibility of misinterpretation? Rewrite the steps until they are crystal-clear.

Every process has two points: a trigger and an end point. The trigger is ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required