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

The Best of the Best Practices

The practices in this chapter should become part of you, as unconscious as your decision to use correct grammar when you speak, and as deliberate as your choice of the right tool would be for a home-improvement job.

And so, in something close to alphabetical order, here are the best practices every technical writer should know.

Active Voice: Don’t Worry, Be Active

Active voice is one of the cornerstones of clear writing. Active voice means that the subject of the sentence (I’m sure you remember learning in grade school that the subject is what the sentence is about and the verb is the action word) performs the action, as in the following example:

A network client sends requests to a server.

The sentence is about ...

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