Archive for Tech Writing

Tech writer interviewing: basic algorithms

When you’re interviewing for a technically oriented tech-writing job in the software industry, chances are fairly good that at some point in the process, you’ll be asked to read some code and explain what it does. So before you apply, I strongly recommend familiarizing yourself with some common simple things that a brief code sample […]

What is the subject of this document?

Probably the most common problem that I see in technical documentation is a failure to say upfront what the thing is that you’re documenting. I feel that in most cases, one of the first pages of the documentation set should have a sentence early on in the page that says something like “[Product name] is […]