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

Technical Documents: 3 Ways to Improve Quality

Who do you write for? This is a problem for many technical writers, especially if you don’t get to meet or interact with your readers. Essentially, you’re writing in the dark. But, that doesn’t mean you can’t improve the usefulness of the documents. Far from it. Technical Documents: How to be more accurate For example, […]

Do Technical Writing projects need a Documentation Plan?

Gordon McLean asks: do you plan to review your plan? This is in relation to the Documentation Plan (aka Information Development Plan) that most technical writers prepare in advance of starting a major project. Granted, on smaller projects you can get away with this if you know the product, have the resources and the deliverables […]