Depending on the amount of text and the information needs of the reader, reading a manual is similar to short or long distance running. Long before the race kicks off for the reader and he starts his manual run, we plan the route, highlight the entry points, define goals, secure the route and provide road signs.
However, despite careful planning, anything may go wrong during the run. Even the fitness of the reader plays a role. But much would be gained, if technical editors create the best possible conditions for a successful manual run.
Planning the route
Before we start writing the manual, we plan the thematic route and divide it into more manageable sections. This lets the manual reader cope with the distance later, without running out of steam.
We fix our route plan in a table of contents, which is, however, not the end of it. During the follow-up, we must check and re-check the ...