Proofreading Tips for Technical Writers

In: TW| tips

12 Mar 2009

Proofreading is an essential step in any kind of writing, but I find it’s especially important in technical writing. That’s because the information you’re trying to transmit to people must be understood immediately for a specific reason. Whether it’s the procedure on how to land a plane, or the description about the new iPhone application you downloaded, it’s got to be in comprehensible. The information must be in small enough chunks that the reader can understand it and assimilate it easily.

This is why the words you choose to use are important.

So here are my 3 proofreading tips for any technical writer out there:

  1. Read it out loud. If it sounds too complicated, it probably is.
  2. Let it marinate. Let your content sit for a few hours or days, if you can. Come back to it later when you haven’t been staring at it for the last 3 days.
  3. Get another pair of eyes on it. A fresh perspective can be helpful. This one’s a little hard for the freelancer, but you can enlist the help of friends, family members or your significant other to help out.

That’s it, that’s all. Nothing too complicated or difficult about it. Three steps and your technical writing projects will be better for it. What are your proofreading tips? Do you do anything different?

3 Responses to Proofreading Tips for Technical Writers

Avatar

Proofreading Tips for Technical Writers - blog @ spacebarpress « Technical Writing

March 12th, 2009 at 15:44

[...] Re­ad mo­re­:  Pr­oofr­e­a­di­n­g Ti­ps for­ Te­chn­i­ca&#17… [...]

Avatar

Yolander

March 12th, 2009 at 22:06

I’m not a tech writer, but my number one trick is to read it out loud. With a manual, I think I would do a really melodramatic reading. :)

Avatar

Julia

March 13th, 2009 at 08:13

Hilarious! That would make writing procedures MUCH more interesting. :-)

Welcome!

I'm a freelance technical writer who's trying to make the transition from working for somebody else to working for me.

  • Julia: Thanks for the support! I know one of these days I'll actually gather up the courage and start query [...]
  • Yo Prinzel: You can do this!! Remember, it's not life or death. It's not personal. It's not that big a deal. The [...]
  • Yo Prinzel: That might also be the official definition for procrastination, I'm not sure :) [...]
  • Julia: Tee hee, plan to pre-plan, NICE! [...]
  • Yo Prinzel: As long as you don't plan to pre-plan, I think you're okay :) [...]
-->

Writer For Hire

  • Need a freelance technical writer for your project?
  • Click here for your no-obligation quote.