Inspired by this post about the XY Problem, let’s talk about how users can approach documentation from a totally unhelpful angle. The gist of the XY Problem is that “I was doing X and it’s not working” is not the same as “I was trying to solve Y; was X the right way to do […]
Recommended reading for you today: Anatomy of an editing comment.
Three little rules: Your first draft is not worth the keyboard it was typed on. If you’re seven rewrites in, you’re probably halfway there. If you can’t imagine what good another pass could do, you’re not done – you’re ready for the first review. Which is the long way of saying: learn to edit, not […]
In no particular order, here are my recommendations for writing samples for those of you applying for a tech writing job. And yes, you need writing samples. Purpose The purpose of writing samples is to prove you have technical writing skills, not that you’ve held down a job. So when you pick or write samples, […]
That dreadful moment (hour? day?) when the words won’t come. We think of writer’s block as something that is stopping a well formed image from settling into the right words. But in reality, a writer’s block happens when our mental image is a little hazy and abstract. We can’t put it into words because words […]
Writing begins with awareness of the single word, then moves up. What can a word mean, and what does it actually mean in its current context? Does the sentence make its point as clearly as possible? Does the paragraph come together as a single point? Is it in the right place Does the whole document tell […]
When users find a gap in your documentation – some jump from A to C that gets negative feedback – don’t just fix it. Ask yourself how it got there. Gaps happen because: Someone didn’t think users needed the topic. This demonstrates a misunderstanding of the audience. someone didn’t think about the topic at all. […]
As a technical writer, one of the most important questions you can ask yourself is “what are the default values of the choices a user can make, and why”. For example, if an option is disabled by default, what does that tell you about the average user and their workflow? Are you trying to protect […]
Oliver Burkeman reviews the basics of thinking about writing.
Agile got (at least) one thing right: stop writing documents no one’s ever going to read. If you want to honestly assess what will or won’t be read – and therefore what should or shouldn’t be written – you should answer some basic questions.