Latest posts by techwriter (see all)
- 15 Questions to Ask After You Finish a Technical Document Project - February 12, 2018
- THY’s Perfect Information Design - February 9, 2018
- Waterfall vs. Agile Models in Technical Documentation - February 7, 2018
© Ugur Akinci
There will be instances in your career as a professional technical writer when you will be asked to “peer review” (which is, yes, a compound “verb” these days) someone else’s or your own work.
This may happen in a group meeting (or teleconference/webinar) setting when you may be invited to offer your views on how to improve a certain copy or a document.
In situations like this, it is important to know how to be positive or productive since such meetings can get “personal” and destructive in a hurry.
Here are 2 Golden Principles to follow to learn and contribute positively to such review processes. Not only your next pay check but your whole career as a writer may actually depend on it.
GOLDEN PRINCIPLE 1: Eliminate “you” from your feedback.
Always talk about yourself and your impressions, feelings, etc. This may not be always possible; but try it anyways.
When you talk about yourself, you’re not criticizing anyone directly. That way it’s harder to disregard what you’re saying.
For example, avoid saying this: “You are not correct in writing ABC.”
Try this: “I felt like ABC may not be correct.”
GOLDEN PRINCIPLE 2: Eliminate generalities and replace them with specifics.
General observations invite endless bickering. Specifics cut down to the chase and give the others a real chance to respond.
Here is a meeting destroyer: “You always do this! It’s as though you are born to be deceptive.” That would be the equivalent of an A-Bomb.
You can try this instead: “I thought the fifth item you brought up on page 23, the one that refers to the UL certification process, should be updated in the light of the new Guidelines published this February by GAO. Have you considered that?”
Now, who can object to that? The chances are the other writer might actually be GRATEFUL for you bringing up such a clear point in such a friendly way and providing an opportunity to improve the document at the same time.