Words on a page

When writing documentation, it’s easy to forget that it will need to be revised sometime in the near future. This is especially true in the case of contractors (who come in, do the job, and then leave) and novice technical writers (who may have only one or two manuals under their belts). Even for the experienced technical writer, developing documentation that easily be revised can be a challenge.

This tutorial, based on the book Writing Revisable Manuals: A Guidebook for Business and Government, offers some good advice on creating documentation that is easy to revise. Note that you can no longer download the templates mentioned in the tutorial.