Alden DeSoto
2y ago
Bringing products and ideas to life with compelling content
Tech writers: Do you struggle with getting SMEs to review your docs? Try this approach.
You're so proud of your completed draft and now you just need folks to review it. But your reviewers keep putting it off. You've tried begging, guilting, reasoning, and bribing, but it's taking forever to get the doc reviewed. Sound familiar?
Newsflash: No one wants to read a long doc, let alone review it.
Your SME knows the docs are important, so they will get to the review "as soon as they can" -- but not today. They'll put it off as long as possible.
That's what happens with large, poorly defined tasks.
Try this instead. Don't wait for a complete draft to ask for a review. Instead, verify your understanding of the product in real time.
Let's say that you're working on your draft in a Google Doc. Comment the paragraph or statement in question and assign it to the SME:
"@SME Is this an accurate statement?"
Alternatively, send them an email / Slack / chat etc:
"Hey SME, is it accurate for me to say the following? [insert text you want to write]".
Pro Tip: Italicize your proposed text. Trust me, it helps. I don't know why.
Most SMEs would rather answer individual questions -- even a lot of questions -- than review a doc. Intelligent questions will feel like normal collaboration to them.
You will be respected as someone who does the background research and is involved with the product. And many of the questions you ask will surface quirks and unresolved issues. The product team will appreciate this.
By the time you get to a final draft, you won't need to have it reviewed.
SMEs often don't know what you need when you dump an entire draft on them. Some SMEs might think that you need them to review the writing or the doc structure. You don't. (Ask other writers to review your writing, don't ask SMEs.)
If you have a hard time believing that you should not ask SMEs for a final review, consider this: Does an investigative journalist ask the subject of an article to review the article?
Of course not. A journalist verifies all the facts, usually by asking the right questions, then writes the piece and stands behind it.
A by-product of this approach is that it forces you to deeply investigate your subject matter. It won't work if you ask lazy, open-ended questions.
Follow this approach and you'll never be blocked on doc reviews again.