Creating modules for technical documentation

Do you remember how you built your first house with Lego blocks? Was there anything that we did not create using these rectangular blocks: Bridges, houses, entire landscapes. The same Lego block can be used at different positions. A smaller one can follow a larger block etc. The color plays a smaller role for the function, but a deciding role in the design of the constructed object. Now what does this have to do with an operating manual?

Text by Britta Görs

Inhaltsübersicht

Creating modules for technical documentation

When modularizing, we follow the Lego principle that we have been familiar with since childhood. Based on the size and color of the Lego block we decide where we will use it in our artwork. Similarly, we must look at a text block and see what content it holds to be able to use it in the appropriate place. In this article, modularization in technical documentation is considered not only as identifying and using text modules, but it also includes the principle of using content from a defined source (the module) using cross-referencing – see Figure 1.

Figure 1: A defined source

Use of terms

In this article, the terms module, text block and text module are used synonymously. A module can be a text or even a graphic. This article focuses on text modules.

Starting point

This article presents the experience of a technical writer and her work using the modular method. Supported by a ...