Tag Archives: software development

Please release me from release notes

I have an admission to make. I detest software release notes. Let me be clear: I am all in favour of keeping customers informed about the latest enhancements to a product, and understand that a new software release is a … Continue reading

Posted in technical writing | Tagged , , | 14 Comments

Asking the right questions

When you’re a technical communicator you need to know what are the right questions to ask – and who to address those questions to. This is the topic I’d been thinking about when my very good friends at Firehead Ltd. asked … Continue reading

Posted in technical writing | Tagged , | 1 Comment

Is there such a thing as a “Programmer/Writer”?

In a recent discussion thread on LinkedIn, someone asked for opinions about the job description for a vacancy for a “Programmer/Writer”. Was it possible they asked, for someone to be both a software programmer and a technical writer? Was it … Continue reading

Posted in Uncategorized | Tagged , , , | 4 Comments

The best place for a tech writer

I have spent most of my tech writing career working with product development teams in software and other hi-tech industries. It is what I enjoy doing. It’s what I do best. And I have come to the conclusion that it’s … Continue reading

Tagged , , , | 7 Comments

Beware the Default Manual

Thomas Barker, in his book Writing Software Documentation, uses the term “the default manual” to describe a user’s guide that is organised according to features, rather than tasks. This sort of user’s guide has a chapter for each menu in … Continue reading

Tagged , , | Leave a comment

At last, some consideration for users

As I work extensively with companies developing computer software and hardware, I am proud to be a member of the British Computer Society (the BCS). I receive regular emails and magazines and occasionally attend local meetings. This week an email … Continue reading

Tagged , , , | 1 Comment