Focus on Technical Writing

Ten Characteristics of a Good Technical Editor

In no particular order,

  • Knows the difference between big picture and details
  • Advocates for the document’s audience
  • Exercises critical thinking
  • Knows the difference between copy editing and technical editing
  • Knows the difference between content and design
  • Maintains communication with clients and other stakeholders
  • Maintains style and tone of documents
  • Can distinguish technical jargon from effective writing
  • Edits according to established practices and style guides (i.e., is not arbritrary)
  • Works with writers and subject matter experts in a collaborative and respectful manner

Technical Writing Style

Last night, I taught one of my best technical writing style classes ever. It’s funny, but I was super nervous before the class—I must have known I was destined for greatest (or something). I think what made the class go so well was that there was a consistent flow from introduction to final farewell that built on the idea that in order to write good technical documentation, you need to understand your audience. I even tied in or foreshadowed themes that I know I’ll be teaching in the ensuing weeks.

The flow from after the break from the card game (barnga) to the presentation on discourse communities to the final humorous presentation of the Grand Central Station freeze worked really well. They get it and they had fun getting it.

Next week, I need to find a way to incorporate the graphic I made a while back lampooning everything that’s wrong with technical documentation:
Where academia meets bureacracy