What should you include in your user documentation?

Technical authors are faced with limited time and resources, so they often are faced with the dilemma as to what to include and what to leave out of their user documentation. You may ask, if 80% read only 20% of the content, is there any value in documenting the rest? Technical Authors are often great… Read more »

Documentation and when things go wrong

The latest edition of the IET’s “Engineering & Technology” magazine looks at engineering disasters and, in doing so, provides food for thought regarding the role of documentation. “Hard lessons” looks at ten disasters, such as the Challenger Space Shuttle, and the reasons why these disasters can occur.  Looking at the disasters, I could see some common themes:… Read more »

Manager’s guide to single sourcing: What’s the problem, why is there a need?

I thought it might be useful to look at a simple question: Why is there a need for single sourcing technical documentation? For people who aren’t technical authors, it’s often unclear why technical authors talk so much about “single sourcing”. Isn’t that just cutting and pasting? What’s the problem? In later posts we’ll look at the… Read more »