Mistakes to Avoid when Evaluating Technical Content

How do you evaluate the quality of your documents in a way that’s impartial, accurate, and easy to implement? Recently we looked at how to create scoring frameworks (usually in Excel) to evaluate and score technical documents. From one angle, the scoring is the easy part. What’s more difficult is getting people onside. Encouraging them […]

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 […]

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.

Favorite 10 Technical Writing Tools

I’ve used the same technical writing tools for the last 5 years. A few products have come across my desk but nothing that really blown me away. Here’s a run-down of what I use to write my technical documents. No order of preference. Which should I keep? Which should I replace?

How to Write a Capacity Plan

Developing a Capacity Plan is vital if you want to understand how much capacity will be required to support your IT systems and, by extension, the infrastructure that supports it. Think about it. If you plan to install a new large-scale solution, for example, IBM WebSphere or SAP, you also need to consider the impact […]