Docs Ready for Tech Review?

Show MarkupPenny Orwick and I completed a series of posts for Steyer Associates on peer reviews for technical documentation.

A point we both made in our example peer reviews was that the original draft content wasn’t ready for review, much less for publication. To wrap up our series, Penny suggested a checklist.

Today’s Ready for Review? A Checklist provides the basics, plus some cautionary notes about what you risk losing if you send poor docs for tech review:

  • Discrediting yourself with your technical experts
  • Discrediting yourself with your peers

Typically I link to my tech-communications blog topic with a parallel for fiction writers. But it seems like there are a lot of models out there. So this time I’ll just link again to my Checklist for Writer/Editor Collaborations.

Other topics in our “peer review tips” collection:

 

You Get What You Measure: Technical Communications Edition

You Get What You MeasureMy Managing Up post for Steyer Associates this month — You Get What You Measure — touches on the difficulty with most metrics for productivity and quality in technical writing. I offer ideas for how to create personal measures to increase your satisfaction as a writer, editor, or other working in the content publishing chain.

Making progress on quality goals, working toward expertise—I believe these are fundamentals for personal ambition.
Sure feels like metrics for corporate tech-comms consistently undermines those personal metrics these days, doesn’t it?

What can we do, oh noble content providers, but go forth and meet our daily word count?
My related post on metrics and productivity in fiction writing is here.

Preplanning? Si! Procrastinating? No!

My post for tech-communications professionals is up today at Steyer Associates web site: Procrastinating … or Preplanning?

I propose in that piece that for professional communicators, most “procrastination” is your brain begging for more preplanning time… though that begs the question:

How is “preplanning” different from regular old planning?

If You Want to WriteIt’s a question of being ready to commit.
I’ve long posited that for any tech-writing project, there’s probably 25 solutions, and you want to concentrate only on the best 3 — then pick one and commit to action.

However, that’s not always so straightforward, whether for tech-writing, fiction, or other projects. Brenda Ueland, in If You Want to Write, presents critical ideas in her chapter, “The Imagination Works Slowly and Quietly.”

Following the “slow imagination” concept, preplanning is: Continue reading →

“Your only job is to make me look good”

I’m offering advice from a manager’s viewpoint for contract technical writers, appearing as a guest blogger for Steyer Associates on the last Thursday of every month. This first post ruminates on my novice experience upon hearing “Your only job is to make me look good.” Two truths: (1) a manager really said that; and (2) I was a novice once.

Check it out: “Getting Started: Managing Up” at Steyer.net