How to Write Release Notes: Faster, Stronger, Better

So, you want to write release notes but don’t know where to start? Well pull you a chair and let me give you the lowdown. Download – Release Notes template with sample text. Introduce the release notes with text such as the following: These release notes provide information about the documentation for <your product> <version […]

How To Write Technical Documentation For APIs

One of the threads on LinkedIn is how to write technical documentation for APIs. It’s been many years since I’ve documented an API (Java & Oracle) so if you have any thoughts on the best way to do this, then please jump in. An application programming interface (API) is an interface implemented by a software […]

Does your technical writing have an accent?

Maybe you don’t hear your accent, but others do. When you read their documents, does the accent come through?

Are technical documents a waste of time?

“Don’t worry” she said. “No one reads this stuff anyway. Just get it done.” Sounds familiar?

How to Write a Target Audience Questionnaire

Creating a training plan? Before you do this, you need to step a step back and work out what your colleagues need to learn.

Can Outsourcing Help Your Technical Writing Career?

Image by Ivan Walsh via Flickr Most technical writers see outsourcing as a real threat. But, if you look at it from another angle, it’s one huge business opportunity.

Is it possible to get into technical writing without a degree?

I got this email during the week. The question was: is it worth the time and money to take a technical writing course? “I’ve been reading articles about Technical Writing and I’m thinking about a change in career. I’ve worked as a non-degreed Quality Engineer in the manufacturing industries. Writing quality documentations and SOPs was […]

7 Ways to Improve Your Technical Writing

Here are seven quick tips to improve the quality of your technical documents. When you write a technical document, consider the following points:

Why use Master Templates in Adobe FrameMaker?

Master templates let you control the format and positioning of every component in your FrameMaker documents.
In plain English this means that if you setup a footer as Arial, size 10, and then apply it to the main document, all footers will appear in this font and this size. Sounds good!