What not to do

Reading time: < 1 min

Working in a team that isn’t heavily invested in documenting requirements and specifications (we usually have a starting set of such things but these soon fall out of step as development evolves) makes it a challenge to know both what is being added to the product and whether it needs to be documented. The development…

The Presumption of Common Sense

Reading time: < 1 min

If there is one phrase which should set off alarms in the mind of a technical writer it’s when a developer says “Ohhh but they wouldn’t use it like that…”. Because, as I’m sure you all know, they will. I am currently working with a few people to try and pull together a solid set…

Planning your deliverables

Reading time: 2 mins

I don’t like making presumptions, something that I learned early on in my technical writing career, but I am going to presume that anyone who reads this knows that they should be planning what content they produce before they start writing. You do, right? A basic information plan will include knowledge about the audience, the…

What do you write?

Reading time: < 1 min

Most of my experience is based around software documentation. Whilst there are several levels to this, from task oriented User Guides through to highly technical API/SDK documentation, they tend to follow similar patterns making it easy for me to take my experience and apply it to new challenges. I’ve also been involved in writing up…