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?
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 ...
Read more after login
tekom members can log in directly with their "My tekom" access data.
You are not yet a tekom member, but would like to read one or more articles in full? Then you have the opportunity to register on the internet portal of the technical journal 'tcworld' without obligation. Once you have registered, you can select any three specialist articles and view them in full for a period of two months. The selection will then be deleted and you can select three new articles for the next two months.
As a tekom member you benefit from the following advantages::
- Online access to all articles of the trade magazine 'tcworld magazine'
- Exclusive specialist articles from all areas of technical communication
- Regular new articles from over 300 authors
- The technical journal 'tcworld magazine' as a printed edition
- Reduced admission prices to tekom conferences
- Membership fees for tekom publications
- Access to 'my tekom', the web forum with job offers / job requests, appointments, expert advice, service provider file and much more
Login
Registration
Promised: The trade magazine 'tcworld magazine' is the best we have. And we don't make the choice easy for ourselves. Every month, the editorial staff of the technical journal 'tcworld magazine' publishes the latest articles by renowned authors. This demanding selection is available exclusively to members of tekom (as usual, including the printed edition).
The trade magazine 'tcworld magazine' stands for intelligently prepared specialist articles, texts written to the point, informative content, surprising insights, international perspectives and communicates technical communication in an understandable, fast, clear and uncomplicated way - exclusively for you.