Documente Academic
Documente Profesional
Documente Cultură
Ausg. deutsch/englisch
Planning, layout, creation Issue German/English
Die deutsche Version dieser Richtlinie ist verbindlich. No guarantee can be given with respect to the English transla-
tion. The German version of this guideline shall be taken as
authoritative.
Vorbemerkung
Der Inhalt dieser Richtlinie ist entstanden unter Beachtung der Vorgaben und
Empfehlungen der Richtlinie VDI 1000.
Einleitung
Die vorliegende Richtlinie VDI 4500 Blatt 4 behandelt Planung, Gestaltung
und Erstellung im Dokumentationsprozess. Die folgende Übersicht zeigt
Blatt 4 im Kontext der Richtlinienreihe VDI 4500.
Blatt 4: • Ziel- und Benutzergruppen • Führungs- und Fachkräfte, die mit dem
Dokumentations- • Bausteine der Prozesskette Erstellen Technischer Dokumentation
prozess: • Werkzeuge beauftragt sind
– Planen • Qualitätsmanagement • externe Dienstleister, die eigenverant-
– Gestalten wortlich Aufgaben übernehmen können
– Erstellen • Personen, die Informationen für die
Technische Dokumentation liefern
Preliminary note
The content of this guideline has been developed in strict accordance with the
requirements and recommendations of the guideline VDI 1000.
All rights are reserved, including those of reprinting, reproduction (photocop-
ying, micro copying), storage in data processing systems and translation,
either of the full text or of extracts.
The use of this guideline without infringement of copyright is permitted sub-
ject to the licensing conditions specified in the VDI Notices (www.vdi-rich-
tlinien.de).
We wish to express our gratitude to all honorary contributors to this guideline.
Introduction
The present guideline VDI 4500 Part 4 deals with planning, layout and crea-
tion in the documentation process. The following overview shows Part 4 in
the context of the series of guidelines VDI 4500.
Part 4: • target and user groups • experts and management, who are
Documentation • modules of the process chain entrusted with the task of creating techni-
process: • tools cal documentation
– planning • quality management • external service providers, who can
– layout assume duties under their own responsi-
– creation bility
• persons who deliver information for tech-
nical documentation
Blatt 6: • Publizieren als Teil des • Verantwortliche, die für die datentechni-
Dokumentations- Dokumentationsprozesses sche Infrastruktur, die Dokumentation
prozess: Publizieren • rechtliche Aspekte und die Verteilung der Dokumente ver-
• Informationszugriff, Schnitt- antwortlich sind
stellen und Standards • Führungs- und Fachkräfte, die Soft-
• Technologien und Systeme ware für den Publikationsprozess aus-
• Qualitätsmanagement wählen oder selbst erstellen
• Praxisbeispiele, Checklisten • externe Dienstleister, die eigenverant-
wortlich Aufgaben übernehmen können
Als eine Ergänzung zu den einschlägigen Normen zeichnet sich diese Richt-
linie dadurch aus, dass die genannten Aspekte streng prozessorientiert zu in-
terpretieren sind. Beim Leser wird ein entsprechendes Abstraktionsvermögen
vorausgesetzt, damit er die Sachverhalte und Beispiele auf sein eigenes Ar-
beitsgebiet anwenden kann. Insbesondere muss er die Auswahl der für seine
Der Prozess steht im Aufgabe und Situation anwendbaren Dokumente im Einzelfall selbst bestim-
Vordergrund men. Ziel der Richtlinie VDI 4500 Blatt 4 ist nicht die Vollständigkeit der
Normenverweise und anderer Ausführungsdetails, stattdessen steht die Pro-
zessbetrachtung im Vordergrund.
Grundlage zum Verständnis von Blatt 4 ist die Richtlinie VDI 4500 Blatt 1.
Diese befasst sich mit den Begriffsdefinitionen und rechtlichen Grundlagen
der Technischen Dokumentation. Insbesondere die Abschnitte, die sich mit
den Verantwortlichkeiten und den rechtlichen Voraussetzungen befassen, gel-
ten auch für die Schritte Planen, Gestalten und Erstellen im Dokumentations-
prozess.
1 Anwendungsbereich
Die Inhalte der Richtlinie VDI 4500 Blatt 4 wenden sich an die Ersteller von
Technischer Dokumentation und besonders an die Zielgruppe der Techni-
schen Redakteure, die im klassischen Sinn Externe Technische Dokumenta-
tion erstellen.
Basis for the understanding of Part 4 is the guideline VDI 4500 Part 1. This
deals with the term definitions and legal bases of technical documentation. In
particular, the sections that deal with the responsibilities and the legal prereq-
uisites are equally applicable to the steps of planning, layout and creation of
the documentation process.
1 Scope
The contents of the guideline VDI 4500 Part 4 are addressed to the creators of
technical documentation and especially to the target group of technical writ-
ers, who create external technical documentation in the classic sense.
Die Richtlinie VDI 4500 Blatt 4 betrachtet das Planen, Gestalten und Erstel-
len von Technischer Dokumentation als Teilprozess im Dokumentationspro-
zess. In der Zielgruppe von Blatt 4 sind in erster Linie Personen, die innerhalb
dieses Prozesses die Technische Dokumentation erstellen, aber auch diejeni-
gen, die Informationen für die Technische Dokumentation liefern oder Teil-
dokumente beistellen.
Interne Technische In jeder Phase des Produktlebenszyklus entsteht Interne Technische Doku-
Dokumentation mentation. Sie verhindert, dass erworbenes Wissen verloren geht und ist
gleichzeitig auch der geforderte aussagefähige Nachweis des Produktherstel-
lers hinsichtlich der Erfüllung der Anforderungen aus den verschiedenen
Rechtsbereichen. Interne Technische Dokumentation stellt die Grundlage für
die darauf aufbauende Externe Technische Dokumentation dar.
Das Benutzen eines Redaktionshandbuchs ermöglicht eine systematische Er-
stellung von Externer Technischer Dokumentation. Dadurch werden die
Dokumentationsprozesse transparent, das Erstellen von Technischer Doku-
mentation wird effizient, und die Dokumente lassen sich in ihrer Qualität ver-
bessern.
Anerkannte Regel der Technik Die Richtlinienreihe VDI 4500 ist eine allgemein anerkannte Regel der Tech-
nik, die wertvolle Hilfestellung und praxisnahe Empfehlungen für das Planen,
Erstellen und Gestalten von Technischer Dokumentation gibt.
The guideline VDI 4500 Part 4 regards the planning, layout and creation of
technical documentation as a sub-process within the documentation process.
The target group of Part 4 primarily contains persons who create the technical
documentation within this process, though also persons who deliver informa-
tion for the technical documentation or provide portions of the documents.
Internal technical In each phase of the product lifecycle, internal technical documentation is
documentation created. It prevents acquired knowhow from being lost and is, at the same
time, also the required informative proof by the product manufacturer regard-
ing the fulfilment of the requirements arising from various legal areas. Inter-
nal technical documentation forms the basis for the external technical docu-
mentation which builds upon it.
The use of an editorial manual allows for systematic creation of external tech-
nical documentation. This makes the documentation process transparent, the
creation of technical documentation becomes more efficient and the quality
of the documents can be improved.
Acknowledged rules of The series of guidelines VDI 4500 is a generally acknowledged rule of tech-
technology nology, which provides valuable help and practical recommendations for the
planning, creation and layout of technical documentation.
3 Dokumentation planen
Zur Sicherung der Qualität und zur Erhöhung der Wirtschaftlichkeit emp-
fiehlt sich eine mit dem Produktlebenszyklus abgestimmte Planung der Tech-
nischen Dokumentation.
Die Planung hängt sehr stark von den unternehmens- und produktspezifi-
schen Prozessen ab. Deshalb können die nachfolgend genannten Planungs-
schritte nur Grundüberlegungen für den individuellen Planungsprozess sein.
3.1 Dokumentenarten
Jeder Schritt im Produktlebenszyklus, den ein Produkt oder eine Leistung
durchläuft, steht im Zusammenhang mit einer dafür notwendigen Dokumen-
tenart.
Der Produktlebenszyklus beginnt mit der Produktidee und endet mit der Wie-
derverwertung oder der Entsorgung (siehe auch Richtlinie VDI 4500 Blatt 1,
Bild 2). Es entstehen mit dem jeweiligen Arbeitsschritt verknüpfte oder
schrittübergreifende Dokumente.
Die Dokumente müssen nicht in unmittelbarem zeitlichen Zusammenhang
mit einem Arbeitsschritt stehen, sondern können vor, während, oder – wenn
notwendig – auch nach dem Schritt erstellt werden.
Während des Produktlebenszyklus entstehen sowohl Dokumente für die Ver-
wendung innerhalb des Unternehmens (Interne Technische Dokumentation)
als auch Dokumente, die mit dem hergestellten Produkt oder der erbrachten
Leistung der jeweiligen Zielgruppe zur Verfügung stehen (Externe Techni-
sche Dokumentation). Siehe dazu auch Richtlinie VDI 4500 Blatt 1, Ta-
belle 1 und Tabelle 2.
Beispiele für die Zuordnung von Dokumenten:
• „Produktion“ im Produktlebenszyklus: interne Dokumente
• „Montage“ im Produktlebenszyklus: interne und externe Dokumente
• „Bedienung“ im Produktlebenszyklus: externe Dokumente
3.2 Planungsschritte
Stellvertretend für die Vielzahl möglicher Planungsschritte werden im Fol-
genden beispielhaft einige herausgegriffen und beschrieben.
Verantwortlichkeiten Das Unternehmen muss durch interne Verfahrensfestlegungen (z.B. Redakti-
onshandbuch, Konstruktionshandbuch) regeln, wer für die Richtigkeit und
Vollständigkeit der Unterlagen verantwortlich ist, die die Grundlage für die
Technische Dokumentation darstellen. Ebenfalls muss festgelegt sein, wie die
Unterlagen rechtzeitig für die nachfolgenden Dokumentationsprozesse in
ausreichender Qualität verfügbar gemacht werden.
Analysen Eine rechtlich einwandfreie und anwendergerechte Technische Dokumenta-
tion setzt voraus, dass
• die Zielgruppen bekannt sind,
• das Produkt analysiert wird,
• die Maßnahmen aus Risikoanalyse und Risikobewertung in Produktent-
wicklung und -dokumentation umgesetzt sind,
• die einschlägigen Normen aus der Normenrecherche in Produktentwick-
lung und -dokumentation beachtet werden und
• die einschlägigen Rechtsvorschriften, insbesondere aus dem Produkt-
sicherheitsrecht, beachtet werden.
3 Planning of documentation
For ensuring quality and increasing economic efficiency, it is recommended
to attune the planning of technical documentation to the product lifecycle.
The product lifecycle starts with the product idea and ends with the recycling
or disposal (see also guideline VDI 4500 Part 1, Figure 2). Documents either
associated with the respective step or spanning several steps are created.
The documents need not necessarily be directly connected to the work step in
terms of time, but can be created before, during or – where necessary – even
after the step.
During the product lifecycle, documents are created both for use within the
company (internal technical documentation) as well as for making available
to the respective target group with the manufactured product or the rendered
service (external technical documentation). See also guideline VDI 4500
Part 1, Table 1 and Table 2.
Figure 3. Product lifecycle and the documents assigned to the individual phases
Bild 4. Zulieferungen für die Technische Dokumentation aus Produktmanagement und Produktentwick-
lung (Hinsichtlich der Kosten- und Terminrahmen ist die Technische Redaktion in den Abstimmungspro-
zess einzubeziehen.)
Ablaufplanung Unabhängig von der Dokumentenart und vom Produkt folgt der Dokumenta-
tionsprozess innerhalb der Technischen Redaktion bestimmten Abläufen, wie
in Bild 5 beispielhaft dargestellt (gezeigt sind nur die wesentlichen Phasen):
Figure 4. Deliveries for technical documentation from product management and product development
(The technical editorial department must be included in the coordination process in respect of the costs
and time frame.)
Process flow planning Independent of the document type and product, the documentation process
within the technical editorial department follows certain operational se-
quences, as represented by way of example in Figure 5 (only the essential
phases are shown):
These process steps accompany the product along the entire product lifecycle
and represent a continuous iteration process, which reflects the progressive
development of the product itself as well as the changes to all the parameters.
Approved versions are to be archived such that the manufacturer can furnish
proof of due diligence at all times during the product lifecycle with the help
of the documents.
Bild 5. Dokumentationsprozess mit typischen Abläufen innerhalb der Technischen Redaktion (Beispiel)
– 18 – VDI 4500 Blatt 4 / Part 4 Alle Rechte vorbehalten © Verein Deutscher Ingenieure e.V., Düsseldorf 2011
Planning of documentation
Planning steps
Figure 5. Documentation process with typical process flows within the technical editorial department
(example)
Target group analysis The target group analysis must be conducted and documented by the manu-
facturer. It considers the user(s) of the technical documentation and focuses
on answering the questions:
• Which target group uses the technical documentation?
• For which cultural circle/which country is the technical documentation
being created?
• What qualifications, experiences and knowledge does the target group
possess?
• Which activities can and may the respective target group perform based
on its qualifications?
All rights reserved © Verein Deutscher Ingenieure e.V., Düsseldorf 2011 VDI 4500 Blatt 4 / Part 4 – 19 –
Dokumentation planen
Planungsschritte
• Under which conditions and in which situation are the product and the re-
spective user information used?
• Which information may not be communicated?
• Which information need not be communicated?
Examples of target groups of internal technical documentation are:
• designer/developer
• project manager
• employees of quality assurance
• managers
Examples of target groups of external technical documentation are:
• operators
• (end-)users
• training personnel
• maintenance and servicing personnel
• personnel for professional dismantling and disposal
• distribution personnel
For the purposeful evaluation of analysis data during target group analysis,
two methods have proved their worth: who-makes-what matrix and persona
method.
It is advisable to first obtain an overall overview of the users, document types
and actions using the who-makes-what matrix. The persona method can sub-
sequently be used to support the technical writers in structuring, content writ-
ing and visualising the contents of individual documents such that they are
target group oriented.
This procedure is recommended both for internal technical documentation as
well external technical documentation.
Who-makes-what matrix The method of who-makes-what matrix leads to a classification of the users in
respect of their activities and typical experiences with the concerned product.
In addition, the activities to be carried out over the entire product lifecycle are
compiled and are assigned to the typical executives. In ideal case, this results
in the required factual contents for the target group oriented document types.
The advantage of this method is the explicit assignment of the tasks to the us-
ers and the resultant classification of the documents.
Table 1 shows in a simplified form, using a concrete example, that the fac-
tual contents for the various user groups can be derived column-by-column
from a who-makes-what matrix. The user guide chapters for the user at the
collection tray, for instance, follow from these.
A chronological representation of the activities and users is not yet important
at this moment.
Persona method From the result of the target group analysis, an ideal type user of the product
is derived, who is described with all properties:
• age
• gender
• education
• interests (even private)
• use pattern
• and the like
Steuerkonsole X X X (Tastenzuord-
bedienen (bedienen) (Fehler prüfen) nung definieren)
Der Vorteil eines solchen detaillierten Benutzerprofils ist, dass dieser ideal-
typische Benutzer, dem man sogar einen Namen zuordnet, vor dem geistigen
Auge des Technischen Redakteurs so visualisiert wird, dass er nicht mehr an-
onym in der abstrakten Benutzerzielgruppe untergeht. Es entsteht eine nahezu
persönliche Beziehung zwischen dem imaginären Benutzer und dem Techni-
schen Redakteur.
Vorgaben und Forderungen Alle produktspezifischen und anwendungsbezogenen Forderungen an die
Technische Dokumentation aus Gesetzen, Verordnungen, Vorschriften, tech-
nischen Normen, Richtlinien, aber auch aus Verträgen müssen vollständig re-
cherchiert und erfasst werden.
Neben direkten Anforderungen von Normen an die Externe Technische
Dokumentation sind darüber hinaus auch Informationen aus produktspezifi-
schen Fachnormen hinsichtlich Gebrauch und Wartung zu berücksichtigen.
Sowohl Lastenheft als auch Pflichtenheft oder Leistungsbeschreibung des
Produkts beinhalten in der Regel Anforderungen an die Technische Doku-
mentation und benennen unter anderem die Zielgruppen für die jeweiligen
Dokumente.
Es empfiehlt sich, alle rechtlichen, technischen und vertraglichen Forderun-
gen – nach Prioritäten geordnet – in Checklisten aufzuführen.
Risikoanalyse und Durch Risikoanalyse und Risikobewertung werden die Restrisiken ermittelt,
Risikobewertung die für die spezifische Tätigkeit an dem oder in der Nähe des Produkts nach
Anwendung von Schutzmaßnahmen verbleiben. Das sind die Risiken, die
durch Konzeptänderung, durch konstruktive Maßnahmen, Vorrichtungen (un-
mittelbare und mittelbare Sicherheitstechnik) und organisatorische Maßnah-
men nicht auszuschließen sind. Die Informationen über Restgefahren fließen
unmittelbar in die Externe Technische Dokumentation ein. Die Externe Tech-
nische Dokumentation darf nicht dazu missbraucht werden, entwicklungs-
technische und konstruktive Mängel auszugleichen.
Gefährdungen und Risiken werden beispielsweise im Fall von Produkten, die
der Europäischen Maschinenrichtlinie (2006/42/EG) unterliegen, durch den
Konstrukteur der Maschine identifiziert bzw. bewertet.
Produktanalyse Die Produktanalyse liefert die Anforderungen an die Inhalte der Technischen
Dokumentation, damit der Anwender das Produkt effizient nutzen kann.
Grundlagen für die Produktanalyse sind:
• bestimmungsgemäße Verwendung des Produkts
• Fehlgebrauch
The advantage of such a detailed user profile is that this ideal type user, who
is even assigned a name, is visualised in the mind’s eye of the technical writer
such that he no longer sinks into the anonymous oblivion of the abstract target
user group. A nearly personal relationship is forged between the imaginary
user and the technical writer.
Hazards and risks are, for instance, identified and/or evaluated by the engi-
neer of the machine in case of products that are subject to the European Ma-
chinery Directive (2006/42/EC).
Product analysis The product analysis delivers the requirements in terms of content of the tech-
nical documentation so that the user can use the product efficiently.
Basic principles for the product analysis are:
• use of the product for the intended purpose and according to instructions
• misuse
Sources Sources of information for technical documentation are e.g. technical docu-
ments, records, contracts and notes as well as e-mails. Information is, how-
ever, communicated through verbal discussions as well.
As preparatory work for talks/discussions, it is advisable to develop a detailed
and researched plan and to use proven methods and questioning techniques.
Well prepared interviews can be conducted efficiently and deliver complete
and explicit information.
Documents and data can be available in a company in various forms and for-
mats. Thus, documents from the development department vary from docu-
ments from the marketing department, even where archiving is concerned.
Documents and data can be available in electronic form or in hard copy.
Standardising of information The variety of sources and archiving types make it necessary to check, select
and protect data and documents. The information should be structured and
standardised in terms of content and format. Depending upon the subsequent
usage type, the preparation can involve a lot of effort. For instance, the filing
in relational databases requires the conversion of the data into electronic for-
mat so that they can be automatically imported and assigned.
ten in elektronische Form derart, dass sie automatisiert eingelesen und zuge-
ordnet werden können.
Anzustreben ist immer eine identische Struktur über alle Dokumente hinweg.
Hier muss – wegen der Unterschiedlichkeit der Dokumente – darauf geachtet
werden, dass die Modularität nicht zu tief greift.
Ähnliches gilt auch für die Struktur der Daten. Historisch gewachsene Daten-
bestände und der Einsatz unterschiedlichster EDV-Systeme produzieren eine
Vielzahl unterschiedlicher Datenformate. Auch hier sind die Vereinheitli-
chung der Datenbestände und die Konzentration auf wenige, universell ver-
wendbare Formate oberstes Gebot.
Standardisierte Prozesse, Wichtig zum Einsatz aller nachfolgenden Techniken sind immer stan-
Dokumente und Daten! dardisierte Prozesse, standardisierte Dokumente und standardisierte
Daten!
Erst nach der Strukturierung von Dokumenten und Daten mit dem Ziel eines
standardisierten Datenbestands kommt die Systemtechnik zum Einsatz.
Nach der Festlegung,
• welche Art von Dokumenten benötigt wird,
• wie hoch der Grad der Automatisierung sein soll und
• welche Anzahl an Dokumenten erstellt werden soll,
erfolgt die Auswahl eines geeigneten Systems. Erst jetzt kann die Entschei-
dung für ein DTP-System oder ein Redaktionssystem erfolgen.
Beim Einsatz aller Systeme ist darauf zu achten, dass
• ein schneller und direkter Zugriff auf die Informationen gewährleistet ist,
• die Daten oder die daraus erstellten Dokumente den jeweiligen Vorgaben
entsprechend langzeitig archiviert werden können,
• die Daten oder die daraus erstellten Dokumente jederzeit – auch in ferner
Zukunft innerhalb des Produktlebenszyklus – zugänglich sind, um sie im
Bedarfsfall einzusehen und gegebenenfalls zu überarbeiten,
• die Rückverfolgbarkeit von Änderungen sichergestellt ist und
• ein langlebiges Datenformat gewählt wird.
4 Dokumentation gestalten
Die Externe Technische Dokumentation hat sich als eigenständige Disziplin
in der Technik etabliert. Parallel dazu ist das Angebot an guter Fachliteratur
beständig gewachsen. In Normen, Grundlagenwerken und in Schriften zu
speziellen Themen der Technischen Dokumentation wird der Stand der
Methodik umfassend und qualifiziert dargestellt.
Die Gestaltung Technischer Dokumentation trägt entscheidend zum Nutzen
und erfolgreichen Benutzen bei. Aus einer Vielzahl von Gestaltungselemen-
ten ergeben sich mannigfaltige Kombinationsmöglichkeiten, mit denen sich
nahezu alle aufgabenspezifischen Anforderungen aus der Praxis und aus den
Rechtsbereichen erfüllen lassen. In dieser Richtlinie werden die Schwer-
punkte vorgestellt, die bei der Festlegung der Gestaltung von Externer Tech-
nischer Dokumentation zu berücksichtigen sind. Die Einsatzmöglichkeiten
und ihre Wirkung sind in der einschlägigen Fachliteratur ausführlich behan-
delt. Auf Ausführungsdetails wird daher in dieser Richtlinie nicht speziell
eingegangen.
Standardised processes, Important for the use of all the following techniques are always standard-
documents and data! ised processes, standardised documents and standardised data!
Only after the structuring of documents and data with the aim of a standard-
ised database is the system technique applied.
The specification
• as to which type of documents is needed,
• how high the degree of automation should be and
• what quantity of documents should be created
is followed by the selection of an appropriate system. Only now can the deci-
sion in favour of a DTP system or a content management system be taken.
While using all the systems, care must be taken that
• quick and direct access to the information is guaranteed,
• the data or the documents created from the data can be archived in the
long term according to the respective specifications,
• the data or the documents created from the data are accessible at all times
– even in the distant future within the product lifecycle – so that they can
be inspected in case of need and possibly revised,
• the reproducibility of changes is ensured and
• a long-lasting database is selected.
4 Layout of documentation
External technical documentation has established itself as a self-contained
discipline in technology. The offer of good technical literature has consist-
ently grown in parallel to this development. In standards, fundamental ap-
proaches and in literature on special topics of technical documentation, the
state of methodology is comprehensibly and qualitatively described.
The layout of technical documentation contributes decisively to the benefit
and successful use of the documentation. A variety of layout elements present
diverse possibilities of combination, with which nearly all task-specific re-
quirements related to practical and legal aspects, can be fulfilled. This guide-
line introduces the focuses that must be considered while specifying the lay-
out of external technical documentation. The usage options and their effects
are treated in detail in the pertinent technical literature. Therefore, layout de-
tails are not dealt with especially in this guideline.
4.1 Grundsätze
Eine gute Gestaltung ist einerseits abgestimmt auf das Produkt selbst und
zum anderen auf die Zielgruppe und auf die ihr zu vermittelnden Informatio-
nen.
Das Gestaltungskonzept fußt auf den Ergebnissen der Produkt- und Zielgrup-
penanalyse, die im Idealfall auch Aussagen zur mentalen Situation und zu den
Umgebungsbedingungen des Nutzers sowie zu der Bedeutung von Gestal-
tungselementen in dessen kulturellem Umfeld liefert. Anforderungen, die
sich durch das Ausgabemedium und den Aufbewahrungsort der Technischen
Dokumentation ergeben, sind ebenfalls zu berücksichtigen.
Zielgerichtet zu gestalten bedeutet, die Informationsinhalte richtig und
schnell erfassbar zu machen. Eine klare und logische Gliederung des Inhalts
wird gestalterisch durch optische Strukturmittel verdeutlicht. Von grundle-
gender Bedeutung sind Wahrnehmung und Verständlichkeit von Texten und
Abbildungen.
Produktgröße und Platzverhältnisse sind zu berücksichtigen, wenn die Ex-
terne Technische Dokumentation direkt auf dem Produkt angebracht werden
muss. Sie muss anwendungsbezogen für die gesamte Nutzungsdauer verfüg-
bar bleiben.
Die Gestaltungsrichtlinien müssen – je nach Einbindung externer Stellen – in
jeweils aktueller Form an externe Dienstleister, Übersetzer und Bauteilliefe-
ranten weitergeleitet werden. Sie dürfen keinen Spielraum für individuelle
Gestaltung lassen. Aber auch im Unternehmen sind die Gestaltungsrichtli-
nien zwingend zu berücksichtigen; sie können in Form von Redaktionshand-
büchern dokumentiert sein.
Die Externe Technische Dokumentation ist stets auch eine Außendarstellung
des Unternehmens und transportiert somit die Unternehmensphilosophie.
Aus diesem Grund sollte das Gestaltungskonzept mit dem Corporate Design
abgestimmt sein.
The layout concept is based on the results of the product and target group
analysis, which – in the ideal case – delivers information even about the men-
tal state and the environmental conditions of the user as well as about the sig-
nificance of layout elements in the user’s cultural environment. Requirements
that result from the output medium and the place of storage of the technical
documentation must be likewise taken into account.
Purposeful layout means to make the informative content quickly and cor-
rectly ascertainable. A clear and logical structuring of the content is illus-
trated creatively through optical structural devices. Of fundamental impor-
tance are perception and comprehension of texts and illustrations.
Product size and space ratios must be taken into account, if the external tech-
nical documentation has to be applied directly on the product. It must be use-
oriented and remain available for the entire useful life of the product.
Depending upon the inclusion of external offices, the layout guidelines must
be forwarded to external service providers, translators and sub-suppliers in
the currently valid version. They should leave no leeway for individual lay-
out. Even within the company, the layout guidelines absolutely must be taken
into account; they can be documented in the form of editorial manuals.
Text Für die textliche Gestaltung sind zum einen das äußerliche formale Erschei-
nungsbild und zum anderen die inhaltliche sprachliche Gestaltung festzule-
gen.
Die inhaltliche Gliederung orientiert sich am Zweck der Externen Techni-
schen Dokumentation und hat demnach den Blickwinkel auf das Produkt, auf
eine zu lösende Aufgabe oder die Abfolge der Lernschritte des Nutzers ge-
richtet.
Bei sensiblen Textarten (z.B. Sicherheitshinweise) ist auf eine konsistente
Formulierung besonders zu achten.
Bild Als wichtige Verständnishilfen müssen Bilder in der Technischen Dokumen-
tation deutlich und eindeutig sein und sich auf das Wesentliche beschränken.
Sie müssen den Text in jedem Fall ergänzen und, dem Handlungsablauf ent-
sprechend, im Text logisch eingebunden sein.
Als Bilder gelten Diagramme ebenso wie Piktogramme, Symbole, Illustrati-
onen und Fotos. Zutreffende Normenwerke, der Informationszweck und die
Zielgruppe bestimmen in erster Linie, in welcher Art eine Information visua-
lisiert werden soll.
Im Hinblick auf notwendige Übersetzungen sollten Bilder keinen Text enthal-
ten.
4.3 Ausgabemedium
Von erheblicher Bedeutung ist die rechtzeitige Auswahl der späteren Medien
zum Verteilen und zum Gebrauch. Die Gestaltungsregeln für die Ausgabe-
medien Print, Bildschirm und Multimedia sind unterschiedlich und in der
Regel nicht miteinander kompatibel .
So ist bei der Ausgabe von Text zu berücksichtigen, dass im Vergleich zum
Bildschirm die Lesegeschwindigkeit von Papierdokumenten um bis zu 30 %
höher ist. Papierlesen wird zudem als weniger anstrengend empfunden, und
der Leser kann vom Gelesenen mehr wiedergeben. Die Beurteilung der Les-
barkeit von Bildschirmtexten wird stärker von der Motivation und Erwartung
der Benutzer beeinflusst, als dies bei Papierdokumenten der Fall ist.
Die Entwicklung eines Gestaltungskonzepts ist besonders anspruchsvoll,
wenn Technische Dokumentation für die Ausgabe in mehreren Medien vor-
gesehen ist (Cross-Media-Publishing).
5 Dokumentation erstellen
Die Inhalte dieses Abschnitts beziehen sich hauptsächlich auf Externe Tech-
nische Dokumentation. Es spricht jedoch nichts dagegen, die nachfolgend
empfohlenen Methoden auf die Interne Technische Dokumentation anzuwen-
den.
Es wird ein Ablauf nach Bild 6 empfohlen, der systematisch von der Zusam-
menstellung der notwendigen Informationen für eine Dokumentation hin zum
Erstellungsprozess mit Texten und Visualisierungsmitteln führt.
5.1 Strukturieren
Strukturieren: Informations- Um die Auswahl der Dokumenttypen zu definieren und für jedes Dokument
auswahl treffen, den Aufbau und die innere Gliederung festzulegen, sind folgende Eingangs-
Strukturkonzept definieren,
informationen wichtig:
Gliederung festlegen
• zutreffendes Normenwerk
• Qualitätsanforderungen
Text For text designing, the external, formal appearance, on the one hand, and the
content writing, on the other hand must be specified.
Thus, for output of text, it must be considered that reading speed in case of
hard copy documents is up to 30 % higher as compared to output on the mon-
itor. Furthermore, reading of hard copy is perceived as less strenuous, and the
reader can reproduce more from what he has read. The evaluation of reada-
bility of display screen texts is influenced more strongly by the motivation
and expectation of the user than in case of paper-based documents.
The development of a layout concept is especially demanding if the technical
documentation is meant for output in several media (cross-media publishing).
5 Creation of documentation
The contents of this section mainly refer to external technical documentation.
However, there is no reason why the methods recommended in the following
should not be applied to internal technical documentation.
5.1 Structuring
Structuring: information In order to define the selection of document types and to specify the structure
selection, defining the and the internal arrangement for each document, the following input informa-
structural concept, specifying
tion is important:
the organisation and
arrangement • applicable set of standards
• quality requirements
• Produktanalyse
• interne oder kundenspezifische Regelwerke
• Zielgruppenanalyse
• Art der Verteilung
• markt- und kundenspezifischen Erwartungshaltungen an die Dokumenta-
tion
Auf Basis dieser Eingangsinformationen ergibt sich nahezu zwangsläufig die
Definition von Dokumententypen sowie die Dokumentenstruktur der Einzel-
dokumente. Zum inneren Aufbau geben die einschlägigen Normen und EU-
Richtlinien mit Verweisen auf die Benutzerinformation wichtige Hinweise,
die unbedingt zu befolgen sind.
Die Vorgehensweise der Strukturierung lässt sich in folgende beispielhafte
Schritte gliedern:
a) gesammelte Informationen aus Recherchen, Analysen und Vorgaben be-
nennen
b) erforderliche und gewünschte Informationen für die Dokumentation aus-
wählen
c) Grobgliederung erstellen (Makrostruktur)
d) ausgewählte Informationen in Abschnitte ordnen (Mikrostruktur)
Eine so aufgebaute Dokumentenstruktur der Technischen Dokumentation
führt zielgerichtet zur sicheren und wirtschaftlichen Nutzung des Produkts.
Empfehlungen für den Informationen für unterschiedliche Zielgruppen sollten in getrennten Doku-
Zielgruppenbezug menten verfasst werden oder zumindest deutlich voneinander getrennt in
einem Dokument erscheinen.
Die Inhaltsstruktur kann nach unterschiedlichen Schwerpunkten aufgebaut
werden:
• produktorientiert
• vorschriftenorientiert
• zielgruppenorientiert
• aufgabenorientiert
• vermittlungsorientiert
In der Praxis ergeben sich häufig Mischformen.
Informationen für Fachpersonal sind deutlich zu kennzeichnen, um eine Aus-
führung durch Laien zu verhindern. Dazu ist die jeweilige Zielgruppe eindeu-
tig zu definieren.
• product analysis
• internal or customer-specific body of rules and regulations
• target group analysis
• type of distribution
• market and customer-specific expectations vis-à-vis the documentation
The definition of document types as well as the document structure of the in-
dividual documents almost inevitably follows from this input information. As
concerns the internal organisation and arrangement, the pertinent standards
and EU directives with references to user information give important instruc-
tions which absolutely must be followed.
The procedure of structuring can be classified into the following exemplary
steps:
a) naming the collected information from research, analysis and specifica-
tions
b) selecting the necessary and desired information for the documentation
• product-oriented
• rule-oriented
• target group oriented
• task-oriented
• communication-oriented
In practice, mixed types are frequently used.
Information for technical personnel is to be clearly marked, in order to pre-
vent execution by laymen. The respective target group is explicitly defined to
this end.
5.2 Modularisieren
Aus folgenden Gründen sollte der modulare Aufbau einer Dokumentation im
Prozess verankert werden:
a) Die Modularisierung von Dokumentationsinhalten gemäß dem techni-
schen Aufbau des Produkts und den jeweils zuzuordnenden Nutzerinfor-
mationen vereinfacht den Entstehungsprozess der Dokumentation.
b) Ein baugruppen- oder komponentenbezogener Aufbau der Dokumentati-
onsinhalte begünstigt die Dokumentation von Produktvarianten.
c) Wiederholt nutzbare Inhalte, die in mehreren Dokumentenstrukturen ver-
wendet werden, reduzieren den Aufwand für das Erstellen, Lektorieren
und Pflegen der Dokumentation.
Es empfehlen sich folgende Abläufe:
a) Zerteilen („Granulieren“) der Gesamtdokumentation in zweckmäßige un-
abhängige Informationseinheiten (Module)
b) Prüfen der Module auf Konsistenz und Selbstständigkeit
c) Metadaten für die eineindeutige Identifizierung der Module vergeben
d) Bausteinverwaltung für das Zusammenstellen einer Gesamtdokumenta-
tion aus zentral verwalteten Modulen einrichten
Bild 7. Aufbau verschiedener Dokumente (hier: Einführung, Bedienung, Wartung) aus mehrfach ver-
wendbaren Modulen eines zentralen Bausteinpools, der auch unterschiedliche Produktvarianten bedie-
nen kann
Content Content and depth of description of the various documents result from the re-
sults of the preceding analyses. Minimum specifications from the laws, regu-
lations, guidelines and standards to be applied to the product absolutely must
be followed. The scope of delivery must be documented in full. The technical
documentation must correspond to the state of the art/the design of the prod-
uct. The depth of description is oriented to the need for explanation of the
product and to the after-sales concept of the manufacturer/supplier.
5.2 Modularising
The modular structure of documentation must be anchored in the process for
the following reasons:
a) The modularisation of documentation contents according to the technical
composition of the product and of the user information to be respectively
assigned simplifies the creation process of the documentation.
b) Assembly groups or component-based structure of the documentation
contents is beneficial for the documentation of product variants.
c) Contents that can be used repeatedly, which can be used in several docu-
ment structures, reduce the effort for the creation, proofreading and up-
dating of documentation.
The following sequences are recommended:
a) fragmentation (“granulation”) of the entire documentation into conven-
ient, independent information units (modules)
b) checking of the modules for consistency and independence
c) assignment of metadata for the unique identification of the modules
d) setting up of module management for the compilation of an overall docu-
mentation from centrally managed modules
Figure 7. Composition of various documents (here: introduction, service, maintenance) from multiple
use modules of a central module pool, which can serve even different product variants
5.3 Standardisieren
Die Standardisierungsziele in der Technischen Dokumentation dienen vor
allem der Transparenz der Dokumentationsprozesse, der Vereinfachung von
Abläufen, der Kompatibiliät von Schnittstellen aller Art und insgesamt der
Reduzierung von Kosten.
Standardisieren lassen sich:
• dokument- und produktbezogene Gliederungsstrukturen
• Visualisierungsmittel
• Sprache und deren Gebrauch
• Gestaltungsvorgaben
• Publikationsprozesse und Medien
• Datei- und Austauschformate
• Arbeitsorganisation
Redaktionshandbuch als In Style-Guides, Corporate-Design-Leitfäden, Qualitätsmanagement-Hand-
Hilfsmittel für konsistente büchern und Redaktionshandbüchern werden die unternehmensbezogenenen
Standardisierung
und produktbezogenen Standardisierungsziele und -mittel dokumentiert und
verbindlich vorgegeben.
Das Redaktionshandbuch definiert den gesamten Workflow im Dokumentati-
onsbereich und schreibt die Dokumentationsprozesse fest. Dazu gehören:
• Datenschnittstellen
• Softwareeinsatz, Technik- und Werkzeugeinsatz
• Dokumententypen und -medien
• Verantwortlichkeiten und Zuständigkeiten
• Prozessschnittstellen
• Freigabeprozesse
• Qualitätsmanagement
Obwohl das Redaktionshandbuch firmenspezifisches Know-how enthält und
daher nicht breit gestreut werden sollte, ist es sinnvoll und notwendig, allen
am Dokumentationsprozess beteiligten Stellen zumindest die einschlägigen
5.3 Standardisation
The standardisation objectives in technical documentation primarily serve the
purpose of transparency of documentation processes, the simplification of
process flows, the compatibility of interfaces of all kinds and the overall re-
duction of costs.
Standardised can be:
• document-based and product-based structuring
• visualisation means
• language and its use
• layout specifications
• publication processes and media
• file and exchange formats
• work organisation
Editorial manual as aid for In style guides, corporate design guidelines, quality management manuals
consistent standardisation and editorial manuals, the company-based and product-based standardisation
goals and means are documented and bindingly specified.
The editorial manual defines the overall workflow in the documentation area
and establishes the documentation processes. These include:
• data interfaces
• software deployment, deployment of technology and tools
• document types and document media
• responsibilities and competencies
• process interfaces
• approval processes
• quality management
Although the editorial manual contains company-specific know-how and
therefore should not be widely distributed, it is advisable and necessary to for-
ward at least the pertinent chapters to all the offices involved in the documen-
5.4 Erstellen
Dieser Abschnitt befasst sich hauptsächlich mit der Umsetzung der struktu-
rierten, modularisierten und standardisierten Inhalte in die verschiedenen
Dokumentenarten. Dem Texten kommt dabei die größte Bedeutung zu, denn im
Bereich der Technischen Dokumentation sind andere Kommunikationswege
– beispielsweise textlose Bildanleitungen – vergleichsweise wenig verbreitet.
Zu unterscheiden sind verschiedene Textarten für unterschiedlichen Medien-
einsatz: So gelten besondere Regeln für gesprochenen Text in Multimedia-
Anleitungen oder übersetzungsfreundliche Texte in Printanleitungen.
Zielgruppengerecht In jedem Fall aber gelten für den Verfasser Technischer Dokumentation be-
formulieren sondere Regeln, die sich nicht notwendigerweise an den in der Schule gelern-
ten Qualitätsbegriffen orientieren. Die Texte müssen ausschließlich in einer
zielgruppengerechten Sprache ausgeführt sein, deren einziges Ziel es ist,
technisch komplexe Sachverhalte prägnant, eindeutig und verständlich zu
vermitteln. Das Resultat muss eine Verkürzung der Lesezeit und eine nach-
haltige Erinnerung sein.
In der Technischen Dokumentation sind Wortwiederholungen kein Zeichen
für schlechtes Deutsch, sondern im Gegenteil erwünscht, um eindeutiges Ver-
ständnis beim Anwender sicher zu erreichen. Eine einfache Sprache ist auch
deswegen gefordert, weil damit die Eindeutigkeit der Ausgangssprache für
den Übersetzungsprozess erzielt wird.
Sprachen Natürliche Sprachen werden als von Menschen gesprochene Sprachen be-
schrieben, die historisch gewachsen sind, wie Deutsch, Englisch, Französisch
usw. Sie enthalten neben einer Vielzahl von Regeln nahezu unzählige Aus-
nahmen und Uneindeutigkeiten. Trotzdem kommt keine Darstellungsart in
der Technischen Dokumentation ohne natürliche Sprache aus.
Künstliche Sprachen wurden für ganz bestimmte Zwecke neu konstruiert, oft
von nur einigen Personen oder einer Gruppe. Zwei der bekanntesten Katego-
rien dieser Sprachen sind:
• Plansprachen, um die internationale Verständigung zwischen verschiede-
nen Kulturen zu erleichtern, beispielsweise Esperanto
• Formale Sprachen, deren praktische Anwendung vor allem im Bereich der
Logik und der Informatik bzw. Programmierung liegt. Die bekanntesten
formalen Sprachen sind C++, Java, SQL, HTML, XML, UML usw.
Formulierungen in Nutzerinformationen sind haftungsbegründend, wenn sie
nicht auf die durchschnittlichen Kenntnisse und Erfahrungen der Zielgruppe
Grundregeln für angemessen ausgerichtet und deshalb für diese nicht unmittelbar verständlich
verständliche Texte sind. Einige Grundregeln führen zu verständlichen und eindeutig zu überset-
zenden Texten:
• kurze Sätze, einfacher Satzaufbau
• Fachbegriffe sind beim ersten Vorkommen oder in einem Glossar zu er-
läutern. Das Erfinden von Fachbegriffen sollte vermieden werden.
• Fachjargon ist unbedingt zu vermeiden. Es empfiehlt sich, während des
Verfassens bereits eine Terminologie zu erarbeiten, die die einheitliche
Verwendung von Begriffen, Wendungen usw. sicherstellt. Dabei sollten
nicht nur technische Fachbegriffe betrachtet werden. Auch Begriffe/Wör-
ter/Wendungen, die z.B. für Handlungsanweisungen verwendet werden,
sollten einheitlich sein.
5.4 Creation
This section deals mainly with the conversion of the structured, modularised
and standardised contents into the various document types. In the process,
content writing is accorded the highest importance, since other communica-
tion channels – for example textless pictorial instructions – are comparatively
less widespread in the area of technical documentation.
To be distinguished are various text types for diverse media use: Thus, special
rules apply for spoken text in multimedia instructions or translation-friendly
texts in print instructions.
Target group oriented In any case, however, the composer of technical documentation is subject to
formulation special rules which are not necessarily oriented to the quality terms learnt in
school. The texts must be exclusively embodied in a target group oriented lan-
guage, the single goal of which is to communicate technically complex facts
concisely, explicitly and comprehensibly. The result must be shortening of
reading time and lasting recall.
Artificial languages were reconstructed for very specific purposes, often only
by a few persons or a group. Two of the best known categories of these lan-
guages are:
• constructed languages, in order to simplify international comprehension
between various cultures, for example Esperanto
• Formal languages, the practical application of which lies primarily in the
area of logic and information technology and/or programming. The best
known formal languages are C++, Java, SQL, HTML, XML, UML, etc.
Formulations in user information are grounds for liability, if they are not ad-
equately adapted to the average level of knowledge and experiences of the tar-
Basic rules for get group and are therefore not directly comprehensible for these users. A few
comprehensible texts basic rules result in comprehensible and unambiguously translatable texts:
Jedoch kann auch der Technische Redakteur die Übersetzung durch Anpassen
der Inhalte vorbereiten. Das betrifft vor allem auch lokale Normen, Richt-
linien und Gesetze, die eine geänderte Technische Dokumentation in jedem
Zielland erfordern können. Dieser Prozess nennt sich Lokalisierung und ist in
der Regel gegenüber einer reinen Übersetzung zwingend erforderlich.
Visualisieren Mithilfe der Visualisierung werden Sachverhalte in die Form einer grafischen
oder visuellen Veranschaulichung gebracht (Bild oder Bildfolge).
Bei Technischen Dokumentationen, die abstrakte Daten und komplexe Zu-
sammenhänge beschreiben, die sprachlich oder logisch nur schwer zu formu-
lieren sind, ist es geboten, die sprachlichen Inhalte durch Visualisierungen zu
ergänzen und sie damit besser verständlich zu machen.
Ein größerer Bildanteil erhöht die Verständlichkeit und die Attraktivität und
verbessert zudem den Leseanreiz.
Von Fall zu Fall ist abzuwägen, welche Art der visuellen Umsetzung optimal
geeignet ist. Hier sind sorgfältig die Erkenntnisse der Wahrnehmungsfor-
schung und die Entwicklung der technischen Möglichkeiten der Visualisie-
rungsmittel zu beobachten. Manche bewährten Methoden zur Erstellung von
Visualisierungselementen werden durch neue wirtschaftlichere Methoden er-
setzt. So lassen sich beispielsweise aufwendig zu erstellende Dokumentati-
onsfotos durch fotorealistische Computergrafik ersetzen, die unmittelbar mit
entsprechenden Programmen aus den häufig im Konstruktionsbereich einge-
5.5 Endfassung
Während des Erstellungsprozesses und danach sind verschiedene Anforde-
rungen zu beachten, die nichts mit den Inhalten der Dokumente zu tun haben,
sondern die Bestandteil des Ausführungskonzepts sind.
construction sector – and, that too, with comparably less effort and expendi-
ture.
Significance of colours While using colours, the difference in importance and meaning attached to
colours in various cultures must be borne in mind.
This is the basis for the selection of operating systems and application soft-
ware as well as formats and data carriers for long-time archiving. In case of
short lifetimes in the EDP area, planning over a period of more than ten years
can hardly be reliable. In any case, carefully designed documentation of soft-
ware operation, file storage and document compilation is indispensible for
such periods.
Documentation software Note: An apparently lowest priced documentation concept from the point of
view of investment can entail high consequential costs and expenditures in the
course of daily handling.
5.5.3 Versionskontrolle
Um Dokumente in unterschiedlichen Ausführungen eindeutig identifizieren
zu können, sollten unterschiedliche Stände der Dokumentation versioniert
werden. Hierdurch ist es möglich, einem Gerät in einem bestimmten Bauzu-
stand die passende Technische Dokumentation zuzuordnen und Änderungen
im Rahmen des Pflegeaufwands nachzuvollziehen. Bei Fehlern in überarbei-
teten Dokumenten kann auf einen früheren Zustand zurückgegriffen werden.
Ältere Versionen sollten archiviert werden, damit jederzeit auf alle ausgelie-
ferten Versionen zugegriffen werden kann. Insbesondere beim Einsatz von
Redaktionssystemen ist großes Augenmerk auf diese Forderung zu legen, da
nicht alle Redaktionssysteme diese Funktion umfassend bieten.
5.5.4 Auslieferung
Jede Technische Dokumentation ist ein Teil des Produkts und muss nach den
gesetzlichen Regeln mit diesem zum gleichen Zeitpunkt ausgeliefert werden.
Alle Tätigkeiten zum Erarbeiten, Prüfen und Fertigstellen der Technischen
Dokumentation sollten deshalb so rechtzeitig gleichlaufend mit den Entwick-
lungsarbeiten begonnen und organisiert werden, dass ausreichend freigege-
bene Technische Dokumentationen mit der Auslieferung der ersten Produkte
verfügbar sind.
Microfilm archives are legible over long periods; all one needs is a micro-
scope – a device at a very low level of integration, about which it can be
assumed that it will remain available in the distant future as well. Addi-
tionally, the data can theoretically remain preserved in reproducible state
over thousands of years if the suitable medium is selected (new develop-
ments use less corrosive metal substrates).
5.5.4 Delivery
Each piece of technical documentation is a part of the product and must be de-
livered simultaneously with the product according to statutory regulations.
All activities concerning developing, checking and finalisation of the techni-
cal documentation must therefore be begun and organised synchronously and
concurrent with the development work, such that sufficient approved techni-
cal documentation is available with the initial deliveries of the product.
Dokumentation eines Im Rahmen der Inbetriebnahme kann es in der Praxis zu Änderungen des Pro-
definierten Zustands dukts kommen.
Dies können beispielsweise sein:
• Anpassungen der Software und der Steuerung,
• bauseitige Änderungen oder auch
• prozesstechnische Anpassungen.
Aus den genannten Gründen resultieren Änderungen der Dokumentation. Der
damit erreichte Stand der Dokumentation wird „As built“-Dokumentation
genannt. Sie bildet den tatsächlichen Zustand des Produkts zu einem im Ver-
trag definierten Zeitpunkt ab.
Dokumentation nach Umbau Die Dokumentation nach Umbau und Modernisierung entsteht meist im Be-
und Modernisierung reich Maschinen- und Anlagenbau. Falls das Produkt wesentlich verändert
wurde oder keine oder nur eine unzulängliche Dokumentation vorhanden ist,
ist es notwendig, diese Dokumentation zu erstellen oder zu aktualisieren. Die
Dokumentation muss den Zustand nach Abschluss der Maßnahmen wider-
spiegeln. Nur auf diese Weise ist eine weitere sichere technische und wirt-
schaftliche Nutzung möglich.
Nachdokumentation im Bereich Nachdokumentation, die im Bereich der Entwicklung von Software und Steu-
Software und Steuerung erung entsteht, wird meist Reverse-Dokumentation genannt. Der Code der
Software oder die Pläne der Steuerung werden in manchen Fällen während
der Entwicklung nicht, unvollständig oder unverständlich dokumentiert.
6 Qualitätsmanagement
Wie jedes andere Produkt soll auch die Technische Dokumentation eine be-
stimmte Qualität aufweisen, die durch systematische Prüfung der Einhaltung
von definierten Prozessabläufen erreicht wird. Zugleich ist auch die Wirk-
samkeit dieser Prozesse zu prüfen. Wie bei jedem anderen Produkt setzen die
Qualitätsprozesse bereits in der Konzeptionsphase einer Technischen Doku-
mentation ein und begleiten sie bis zum Ende des Produktlebenszyklus.
Begriffe Über das Qualitätsmanagement werden die Verfahren zum Nachweis der ge-
wünschten Dokumentationsqualität festgelegt. Zu den Verfahren gehören un-
ter anderem:
• Definieren der zu betrachtenden Qualitätskriterien und der zu erreichen-
den Qualität
• Auswahl der Ressourcen, z.B. Software
• Sicherstellen der Personalqualifikation
• Festlegen der Qualität bestimmender Prozessschritte
• Festlegen von Zuständigkeiten und Verantwortlichkeiten
• Definition von Prozessen zur Kosten- und Terminkontrolle
• Dokumentation festgestellter Mängel und Prozesse als Grundlage zur Be-
seitigung der Mängel
Die Qualitätssicherung sorgt im Planungs- und Erstellungsprozess einer
Technischen Dokumentation für die Einhaltung der vom Qualitätsmanage-
Documentation of a In the course of commissioning, changes can be made to the product in prac-
defined condition tice.
These can, for example, be:
• adjustments of the software and of the control system,
• changes made at the customer end, or even
• process engineering adjustments.
Changes in documentation are made for the aforementioned reasons. The sta-
tus of documentation therewith achieved is called “as built” documentation.
It reflects the actual status of the product at a moment defined in the contract.
Documentation after rebuild Documentation after reconstruction and modernisation is created mostly in
and modernisation the area of mechanical and plant engineering. In case the product has been
changed significantly or if only inadequate documentation is available or
none at all, it is necessary to create or update this documentation. The docu-
mentation must reflect the status after conclusion of the measures. Only in
this way is continued safe, technical and economical usage possible.
Post-documentation in the area Post-documentation that is created in the area of development of software and
of software and control system control systems, if often referred to as reverse documentation. The code of the
software or the diagrams of the control system are in many cases not docu-
mented, incompletely documented or incomprehensibly documented during
the development phase.
Then it is necessary to document the code at a later date, or to update it such
that the actual status is reflected. Often, continued technical and economical
use, maintenance and further development are possible only in this way.
6 Quality management
Like every other product, technical documentation too must exhibit a certain
quality, which is achieved by systematic checking of the compliance with de-
fined process flows. Also, the effectiveness of these processes must be
checked. Like in every other product, the quality processes begin right at the
conception stage of technical documentation and accompany it up to the end
of the product lifecycle.
Terms Quality management is used to specify the processes that serve as proof of the
desired document quality. The processes include, among others:
6.1 Schwachstellenanalyse
Soll eine vorhandene Technische Dokumentation weiter verwendet oder
überarbeitet werden, so ist eine Schwachstellenanalyse unter Auswertung der
bisherigen Erfahrungen und der Kundenreaktionen sowie auf Basis prakti-
scher Anwendung von Prüfkriterien empfehlenswert. Alle Erfahrungen aus
gezielter Produktbeobachtung – insbesondere auch bei Wettbewerbsproduk-
ten – sind dabei zu berücksichtigen.
Zudem sollte auch der Dokumentationsprozess selbst in regelmäßigen Ab-
ständen einer Schwachstellenanalyse unterzogen werden.
6.1.1 Prüfkriterien
Jede Technische Dokumentation sollte in allen Phasen der Entstehung nach
einer produktspezifischen, unternehmenseigenen und anwendungsbezogen
erstellten Kriterienliste überprüft werden. Eine vollständige und allgemein
gültige Kriterienliste für alle denkbaren Produkte kann nicht erstellt werden,
weil Qualitätsanforderungen, Prüfkriterien und Dokumentationsprozesse un-
ternehmensspezifisch sind. Die nachfolgend beispielhaft aufgeführten Prüf-
kriterien müssen produktspezifisch und anwendungsbezogen individuell er-
gänzt werden.
lowed. In this context, the following processes, among others, are thinkable:
• fulfilment of the wish of having eliminated the perceived (or in part actual
defect) by following the technical documentation, whereby the so-called
experienced quality in use meets the expectations
• vocabulary that is apt for the target group (in respect of word length, level
of awareness of the words, etc.), sentence structure (length, type, struc-
ture) and other text factors
Meaningful, comprehensible, • briefness, simplicity and conciseness, in order to be correctly and quickly
legible, clearly structured, comprehensible
learnable, implementable
• divided into chapters that do not overlap in terms of content as far as pos-
sible and together form a complete piece of documentation
• adequate addition of visualisation elements to the texts
• introduction of target group specific abstraction levels
• The individual topics sought can be quickly found thanks to adequate
structuring, navigation or hierarchical arrangement.
• optimal layout of the navigation and orientation elements
• list of key words and list of contents (in case of display screen documents
preferably with links to the text)
Economic efficiency • can be created and changed automatically (systematic modularisation)
• Corrections and additions should be cost-efficient in the economical
sense.
• multiple use (single source publishing, cross-media publishing)
6.3 Akzeptanzuntersuchungen
Die Technische Dokumentation soll wirksam und sicher das entsprechende
Wissen vermitteln, damit die Benutzer diese Informationen unmittelbar und
ohne Zweifel in Handlungen umsetzen können. Als Kriterien dienen Antwor-
ten auf folgende Fragen:
• Wie lange brauchen Testpersonen bis zur Inbetriebnahme und Nutzung
des Produkts (Bedienschnelligkeit)?
• Welche und wie viele Bedienschritte werden erfolgreich vollzogen?
• Welche der verschiedenen Produktfunktionen werden im ersten Anlauf
genutzt?
• Wie lange dauern die einzelnen Schritte (Soll-Ist-Vergleich)?
• Welche Unklarheiten oder Schwierigkeiten entstehen beim ersten Nutzen
des Produkts?
• Wie hoch ist die Zufriedenheit des Anwenders mit dem Produkt und sei-
ner Bedienung?
• Wie ist die Einstellung des Anwenders zum Produkt (technische Komple-
xität, Bedienungsfreundlichkeit usw.) vor und nach dem Test?
Verfahren • Mit einstufigen Verfahren werden abgeschlossene Benutzerinformationen
vor ihrem Inverkehrbringen geprüft. Nachträgliche Verbesserungen oder
Veränderungen von Produkt und Benutzerinformation sind meist nicht
mehr möglich.
• Bei mehrstufigen Verfahren parallel zur Produktentwicklung können so-
wohl die Produktgestaltung als auch Art, Gestaltung und Inhalt der Benut-
zerinformation zielgruppenkonform beeinflusst werden; sie sind deshalb
gegenüber dem einstufigen Verfahren zu bevorzugen.
• How is the attitude of the user towards the product (technical complexity,
service-friendliness, etc.) before and after the test?
Process • Before putting into circulation in the market, concluded user information
is tested using a single-step process. Subsequent improvements or
changes of product and user information are mostly no longer possible.
The methods of acceptance tests can be applied before or after the product in-
troduction.
Test methods Prior to product entry, the following methods present themselves:
prior to market entry
• survey
Survey of test persons before or after a user test while simultaneously ob-
serving their behaviour (see below) is the most widespread and effective
method in practice.
• Beobachtung
Bei diesem Test wird das Produkt mit seiner Benutzerinformation verschie-
denen Testpersonen zur Verfügung gestellt. Bei der Beobachtung nehmen
die Testpersonen mithilfe der Externen Technischen Dokumentation das
Produkt in Betrieb, vollziehen Bedienschritte nach oder führen Produktan-
wendungen durch. Die Beobachtung erfolgt offen, das heißt, der Testperson
ist bewusst, dass sie beobachtet wird. Das Erfüllen der Zielvorgaben, Be-
dienschnelligkeit, erfolgreich absolvierte Bedienschritte sowie benötigte
Zeiten lassen sich auch durch Nichtfachleute zweifelsfrei und direkt aus-
wertbar ermitteln. Die Aufzeichnung der Versuchsdaten sollte durch techni-
sche Hilfsmittel (Audio-/Videoaufzeichnung) unterstützt werden.
• interne Vorprüfungen
Anhand von Checklisten werden von Mitarbeitern unterschiedlichster Ab-
teilungen (z.B. Marketing, Vertrieb, Service, Technische Redaktion) ein-
zelne Forderungen auf ihre Erfüllung hin überprüft, um Verbesserungs-
oder Änderungsbedarf zu ermitteln. Die Checklisten sind nach den Prüf-
kriterien (siehe oben) produktspezifisch und anwendungsbezogen zu er-
stellen.
Des Weiteren können Labortests mit Prototypen, Expertenbefragungen sowie
spezielle Anwendertests durchgeführt werden. Bei Letzteren wird unterschie-
den zwischen
• internen Tests
(mit Mitarbeitern des Herstellers, Händlern oder Verkaufspersonal) und
• externen Tests
(mit Mitarbeitern wichtiger Kunden oder zufällig ausgewählten Erstbe-
nutzern der Zielgruppe).
Mit diesen Methoden zur Akzeptanzprüfung sind sowohl Produktgestaltung
als auch Inhalte von Technischer Dokumentation wiederholt zu überprüfen.
Die Freigabe zur Fertigung des Produkts und des endgültigen Inhalts der
Technischen Dokumentation sollte erst nach Abschluss dieser Prüfungen und
nach ihrem gezielten Auswerten durch die für Gestaltung, Vertrieb und Kun-
dendienst verantwortlichen Führungskräfte erfolgen.
Besonders wichtig ist der Nachweis der Erfüllung aller Sicherheitsanforde-
rungen aus Rechtsnormen und allgemein anerkannten Regeln der Technik.
Untersuchungsmethoden nach Auch nach der Produkteinführung können Akzeptanzuntersuchungen, z.B.
Markteinführung durch Expertenbefragungen, nützlich sein. Dabei werden das Wissen und die
praktische Erfahrung externer Spezialisten oder Gutachter genutzt.
Es können auch Organisationen wie die Stiftung Warentest, Verbraucherorga-
nisationen oder Technische Überwachungsvereine hinzugezogen werden.
Empfehlenswert ist es, bei Prüfungen erfahrene Mitarbeiter des Verkaufs oder
des Kundendiensts einzubeziehen, die Erkenntnisse aus der Nutzung ähnli-
cher Produkte einbringen können.
• monitoring
In this test, the product with its user information is made available to vari-
ous test persons. In the monitoring phase, the test persons put the product
into operation with the help of the external documentation, reproduce op-
erating steps or apply the product. The monitoring is done openly, i.e. the
test person is aware that he is being observed. The fulfilment of target
specifications, promptness of operation, successfully concluded operating
steps as well as the required time spans can be determined and evaluated
even by non-specialist persons unambiguously and directly. The recording
of test data should be supported by technical aids (audio-/video record-
ing).
• internal preliminary tests
Based on checklists, employees from diverse departments (e.g. marketing,
distribution, service, technical editorial department) check individual re-
quirements for their fulfilment, to determine any need for improvement or
change. The checklists must be product-specific and use-oriented accord-
ing to the test criteria (see above).
• internal tests
(with employees of the manufacturer, dealer or sales staff) and
• external tests
(with employees of important customers or accidentally selected first us-
ers of the target group).
Both product design and contents of technical documentation are to be repeat-
edly tested with these methods for the acceptance test. The approval for pro-
duction of the product and of the final contents of the technical documenta-
tion should be given only after conclusion of these tests and after their selec-
tive evaluation by the senior managers responsible for design, distribution
and customer service.
The technical writer is responsible for time and resource planning of the doc-
uments to be created:
• deadlines
• personnel
• assignment of order to other departments or service providers
• costs
• work equipment
The tasks of a technical writer include, among others:
• analysing (product and target group analysis, check of legal conditions,
assessment of residual risks for safety instructions)
• collecting and selecting of information
• selection of the suitable publication medium (online, print, CD-ROM and
the like)
• conception (final definition of the overall concept, of the individual parts,
of the implementation steps)
• creation of the final manuscript (formulation of the texts, creation or as-
signing the creation of the corresponding graphics, illustrations and pho-
tos, translations into other languages)
• internal practical test
• correction run
• final correction
• preparation, initiation and monitoring of production (such as set, print)
Glossar
After-Sales-Konzept Konzept sämtlicher Maßnahmen des Unternehmens, um den Kunden nach
dem Kauf eines Produkts oder einer Dienstleistung von der Richtigkeit seiner
Entscheidung zu überzeugen, bei der Anwendung zu unterstützen und ihn an
das eigene Geschäft zu binden.
Anmerkung: Unternehmen mit einer optimal zugeschnittenen Umsetzung des After-Sales-Kon-
zepts können damit wesentlich zu Profitabilität des Unternehmens beitragen. Hierbei gilt der
Grundsatz: „Nach dem Kauf ist vor dem Kauf“.
Externe Technische Beinhaltet alle technischen Informationen über Produkte, die von einem Her-
Dokumentation steller/Vertreiber für Vertrieb, Anwender und Verbraucher bestimmt sind, und
dient der Produktnutzung durch den Anwender.
Anmerkung: Die Dokumentenarten und Dokumentationsprozesse können vielfältig sein. Qualität
und Verständlichkeit der Externen Technischen Dokumentation bestimmen, ob und inwieweit die
jeweiligen Zielgruppen die angebotenen Leistungen und Funktionen der Produkte vorteilhaft für
sich nutzen können. Marketingunterlagen müssen ebenfalls in die Dokumentationsprozesse mit
einbezogen werden.
Hamburger Ein bekannt gewordenes Modell über verständliche und erfolgreiche Sprache.
Verständlichkeitsmodell Es werden vier „Verständlichmacher“ dargestellt: Einfachheit, Gliederung und
Ordnung, Kürze und Prägnanz sowie schließlich die zusätzliche Stimulanz.
Die jeweilige Gruppe wird weiter untersucht bzw. verfeinert und benotet.
Anmerkung: Innerhalb der Gruppe Einfachheit wird beispielsweise zwischen kurzen, einfachen
Sätze und langen, verschachtelten Sätzen unterschieden und dafür Noten auf einer Skala von 2 für
die einen bis zu –2 für die anderen vergeben.
Interne Technische Beinhaltet alle technischen Informationen über ein Produkt, die im Unterneh-
Dokumentation men verbleiben.
Anmerkung: Interne Technische Dokumentation muss sämtliche Produktentwicklungsschritte als
Nachweis transparent, reproduzierbar und nachvollziehbar festhalten – von der Produktanalyse
bis hin zur Entsorgung. Über den Umfang einer Internen Technischen Dokumentation zu einem
Produkt entscheidet immer allein der Hersteller entsprechend den gesetzlichen Forderungen und
der Verantwortung gegenüber den Kunden.
Layout Englisch für „Plan, Entwurf, Anlage“, bezeichnet das Design innerhalb der
→Technischen Dokumentation, um einen ausgewogenen und geordneten
visuellen Eindruck zu erwecken und einen günstigen Lesefluss zu ermög-
lichen.
Glossary
After-sales-concept Concept of all measures of the company, in order to convince the customer of
the correctness of his decision after the purchase of a product or a service, to
support the user in making use of the product/service and to bind him to his
purchase.
Note: Companies with an optimal implementation of the after-sales-concept can therewith con-
tribute significantly to the profitability of the company. The maxim that applies here is: “after-
sales is pre-sales”.
Note: It is a solution concept that is becoming ever more important, because it permits savings to
be achieved.
External technical Technical manufacturer/distributor information about products that are meant
documentation for distribution, users and consumers and serve the purpose of product use.
Note: The document types and documentation processes can be diverse. Quality and comprehen-
sibility of the external technical documentation determine as to whether and to what extent the re-
spective target groups can use the offered services and functions of the product to their advantage.
Marketing documents must be likewise included in the documentation processes.
Infrastructure Long-lasting basic facilities that are personnel-based or are material or insti-
tutional in nature.
Internal technical Technical information about products that remain in the company, for in-
documentation stance, information pertaining to development, test and production.
Note: Internal technical documentation must record in writing all the product development steps
as evidence that is transparent, reproducible and retraceable – from the product analysis up to the
disposal processes. The manufacturer alone decides about the extent of internal technical docu-
mentation about a product according to the statutory requirements and the responsibility vis-a-vis
the customer.
Layout Layout (plan, design) within →technical documentation denotes the design
used to create a balanced and orderly visual impression and to permit a fa-
vourable flow of reading experience.
Anmerkung: Hierbei geht es beispielsweise um eine eindeutige Trennung von Spalten, die Be-
grenzung von Zeilenlängen, Festlegung von Leit- und Ergänzungsmedien, Entscheidungen über
den Einsatz von Farben und vieles mehr.
Pflichtenheft Dokument, das in konkreterer Form beschreibt, auf welche Weise die pro-
dukt- und dokumentationsspezifischen Anforderungen des →Lastenhefts
verbindlich festgeschrieben werden. Laut DIN 69905 sind dies „die vom
Auftragnehmer erarbeiteten Realisierungsvorgaben aufgrund der Umsetzung
des vom Auftraggeber vorgegebenen Lastenhefts“.
Anmerkung: Es wird vom Auftragnehmer formuliert und auf dessen Wunsch vom Auftraggeber
bestätigt.
Produktlebenszyklus Modell, das die „Lebensdauer“ eines Produkts in mehrere Phasen unterteilt (siehe
Bild 3).
Qualitätsmanagement Maßnahmen des Managements, die der Verbesserung von Produkten bzw. der
Erreichung der vorgegebenen Qualität dienen. Es umfasst die Optimierung
von Kommunikationsstrukturen, Definition der dafür erforderlichen Verant-
wortlichkeiten, Prozesse und erforderlichen Mittel für die Qualitätspolitik ei-
nes Unternehmens oder einer Organisation.
Anmerkung: Das Qualitätsmanagement ist in der ISO-9000-Familie beschrieben, aber auch in
anderen Normen wie DIN EN ISO/IEC 17 025.
Redaktionshandbuch Vom Technischen Redakteur mit dem Ziel erstelltes Dokument, technische
Dokumentation zu erleichtern, zu rationalisieren und zu vereinheitlichen.
Anmerkung: Neben Style-Guides, das heißt Gestaltungsrichtlinien für die zu erstellenden Doku-
mente, sollte es Arbeitsanweisungen, Checklisten und andere Hilfsmittel enthalten.
Risikoanalyse Die Risikoanalyse ist der Prozess, um Gefährdungen und deren Ursachen zu
erkennen sowie deren Risiken qualitativ und quantitativ zu erfassen.
Note: Important here is, for instance, a clear separation of columns, restricted row lengths, spec-
ification of dominant media and supplementary media, decisions about the use of colours and
much more.
Performance Document that describes in concrete terms as the way in which the product-
specifications and documentation-specific requirements of the →tender specifications shall
be recorded in writing as binding. According to DIN 69905, these are “reali-
sation specifications developed by the contractor based on the implementa-
tion of the tender specifications given by the awarding authority”.
Note: It is formulated by the contractor, who asks the awarding authority to confirm it.
Product lifecycle Model that sub-divides the “lifecycle” of a product into several phases (see
Figure 3).
Quality management Measures of the management, which serve to improve the products and/or
achieve the specified quality. It includes the optimisation of communication
structures, definition of the responsibilities, processes and means required for
the quality management policy of a company or an organisation.
Note: Quality management is described in the ISO-9000 family of standards as well as in other
standards such as DIN EN ISO/IEC 17025.
Editorial manual Document authored by the technical writer with the aim of simplifying, ra-
tionalising and standardising technical documentation.
Note: In addition to style-guides, i.e. layout guidelines for the documents to be created, it should
contain work instructions, checklists and other aids.
Risk analysis The risk analysis is the process, to recognise risks and compile their causes as
well as their risks qualitatively and quantitatively.
Risk estimation Risk estimation is a structured process for identification (→risk analysis) and
evaluation of risks. The evaluation starts with the stocktaking of potential
hazards and the associated risks, their probability of occurrence and their pos-
sible consequences. The risks thus evaluated are then reconciled with previ-
ously defined risk criteria.
Technische Sammelbegriff für alle Dokumente über technische Produkte, Prozesse und
Dokumentation (TD) deren Einsatz und Verwendung.
Anmerkung: Die Technische Dokumentation muss in übersichtlicher und logischer Form sach-
lich richtig alle Informationen bereitstellen, die zweckentsprechend von ihr erwartet werden, z.B.
für Akquisition, Verkauf, Projektierung, Montage, Betrieb, Instandhaltung, Entsorgung. Dies ge-
schieht in Form von →Lasten- und →Pflichtenheften, Werbeschriften, Produktbeschreibungen,
Gebrauchs- und Betriebsanleitungen, Wartungshandbüchern, Teilekatalogen, Programmieranlei-
tungen u.a.
XPS XPS (XML Paper Specification). Ein neues Dateiformat für Dokumente, um
elektronische Unterlagen in eine allgemein lesbare Form zu bringen.
Anmerkung: Es ist als eine Alternative zum Adobe ® Portable Document Format (PDF) von der
Firma Microsoft® entwickelt. Dieses Dateiformat wurde 2005 erstmals vorgestellt und soll für
hochwertige Ausdrucke, erleichterten Datenaustausch und erhöhte Dokumentensicherheit sorgen.
Single-source publishing Procedure for the management, control, archiving and provision of electroni-
cally composed documents. The basic aim is the multiple uses of available data,
in order to achieve an entire palette of flexible options for various output for-
mats from a single source.
Technical Collective term for all documents about technical products, processes and
documentation (TD) their deployment and use.
Note: Technical documentation must make available all information that is expected of it expedi-
ently in clearly arranged, logical and factually correct way, e.g. for acquisition, sale, project engi-
neering, installation, operation, servicing, disposal. This happens in the form of →tender specifi-
cations and →performance specifications, advertising copy, product descriptions, user guides and
operating instructions, maintenance manuals, parts catalogues, programming instructions and the
like.
Company processes Core processes, management processes and support processes of a company.
Note: According to ISO 9001, the management of a company must name the main processes
which are directly connected to the production or service provision. Furthermore, the top manage-
ment must determine the remaining processes, which influence the effectiveness of these main
processes and/or the requirements of the interested parties. The business process model plays an
important role, because it is the basis for the introduction of a process-oriented quality manage-
ment.
Who-makes-what matrix Process of target group analysis in the course of which activities to be carried
out over the entire product lifecycle are compiled in a well-arranged matrix
and are assigned to the typical executives. At this juncture, there is an explicit
assignment of the tasks to the users and the resultant classification of the doc-
uments (see also →target group, →target group analysis, →persona method).
Note: This procedure has proved its worth in practice for the purpose of arriving at a classification
of the users in respect of their activity and typical experiences.
Note: XML documents appear similar to HTML documents: They contain “tags” enclosed in an-
gle brackets. Unlike HTML, no single element type (“tag”) in XML is predefined in terms of its
meaning. This implies that each person can compile his own elements and his own vocabulary.
XPS Abbreviation for “XML paper specification”. A new file format for documents,
in order to convert electronic documents into a generally legible format.
Note: It has been developed by Microsoft® as an alternative to Adobe® Portable Document Format
(PDF). This file format was presented for the first time in 2005 and shall ensure high-value print-
outs, simplified data exchange and increased document protection. XPS is a fixed component of
XPS ist fester Bestandteil von 2007 Microsoft Office® und Microsoft Windows Vista®, aber es ist
grundsätzlich plattformunabhängig und steht lizenzfrei zur Verfügung.
Zielgruppenanalyse Verfahren zur Ermittlung einer auf die Zielgruppe angepassten →Techni-
schen Dokumentation. Es werden Eigenschaften und das Verhalten von Le-
sern der Technischen Dokumentation untersucht, um eine möglichst gute Ge-
brauchstauglichkeit innerhalb eines gegebenen Benutzungskontexts zu errei-
chen (siehe auch →Persona-Methode, →Wer-macht-was-Matrix).
2007 Microsoft Office® and Microsoft Windows Vista®, but it is basically platform-independent
and is available in the public domain.
Target group A defined group of persons with comparable characteristics to which the
→technical documentation is addressed. The description of a target group is
done, for instance, by category of age, knowledge, intelligence, context of
use, socio-cultural and psychological properties, understanding of the lan-
guage, product experience, understanding of technology.
Note: The target group must be mentioned in the technical documentation. This avoids incorrect
use and is, among other things, imperative under the Product Liability Act.
Target group analysis Process for determining a →technical documentation that is adjusted to the
target group. Properties and the behaviour of readers of technical documenta-
tion are analysed, in order to achieve the best possible fitness for use within a
given context of use (see also →persona method, →who-makes-what ma-
trix).
Schrifttum / Bibliography
Gesetze, Verordnungen, Richtlinie 98/37/EG des Europäischen Parlaments und des Rates vom 22. Juni 1998 zur Anglei-
Verwaltungsvorschriften / chung der Rechts- und Verwaltungsvorschriften der Mitgliedstaaten für Maschinen (Direc-
Acts, ordinances, tive 98/37/EC of the European parliament and of the Council of 22 June 1998 on the approxima-
tion of the laws of the member states relating to machinery). Zurückgezogen / Withdrawn 2009-
aministrative regulations
12. Nachfolgedokument 2006/42/EG / Following document 2006/42/EC
Richtlinie 2006/42/EG des Europäischen Parlaments und des Rates vom 17. Mai 2006 über
Maschinen und zur Änderung der Richtlinie 95/16/EG (Neufassung) (Directive 2006/42/EC of
the European Parliament and of the Council of 17 May 2006 on machinery, and amending Direc-
tive 95/16/EC (recast))
Gesetz über technische Arbeitsmittel und Verbraucherprodukte (Geräte- und Produktsicherheits-
gesetz – GPSG) vom 6. Januar 2004 (BGBl I, 2004, Nr. 1, S. 2–20), zuletzt geändert am zuletzt
geändert am 07.03.2011 (BGBl I, 2011, Nr. 9, S. 338–340)
Technische Regeln / ANSI Z 535.6:2011-00 Product Safety Information in Product Manuals, Instructions, and Other
Technical rules Collateral Materials. Washington, D.C.: ANSI
BGV A 8:2002-01 BG-Vorschrift; Sicherheits- und Gesundheitsschutzkennzeichnung am Ar-
beitsplatz. Köln: Carl Heymanns Verlag
DIN 4844-2:2010-12 (Entwurf / Draft) Grafische Symbole; Sicherheitsfarben und Sicherheitszei-
chen; Teil 2: Registrierte Sicherheitszeichen (Graphical symbols; Safety colours and safety signs;
Part 2: Registered safety signs). Berlin: Beuth Verlag
DIN 4844-2:2001-02 Sicherheitskennzeichnung; Teil 2: Darstellung von Sicherheitszeichen
(Safety marking; Part 2: Overview of safety signs). Berlin: Beuth Verlag
DIN 69901-1:2009-01 Projektmanagement; Projektmanagementsysteme; Teil 1: Grundlagen
(Project management; Project management systems; Part 1: Fundamentals). Berlin: Beuth Verlag
DIN 69901-5:2009-01 Projektmanagement; Projektmanagementsysteme; Teil 5: Begriffe
(Project management; Project management systems; Part 5: Concepts). Berlin: Beuth Verlag
DIN 69905:1997-05 Projektwirtschaft; Projektabwicklung; Begriffe (Project business; Perform-
ing of projects; Terminology). Zurückgezogen 2009-01. Nachfolgedokumente DIN 69901-1 und
DIN 69901-5
DIN EN 61310-1*VDE 0113-101:2008-09 Sicherheit von Maschinen; Anzeigen, Kennzeichen
und Bedienen; Teil 1: Anforderungen an sichtbare, hörbare und tastbare Signale (IEC 61310-1:
2007); Deutsche Fassung EN 61 310-1:2008 (Safety of machinery; Indication, marking and actu-
ation; Part 1: Requirements for visual, acoustic and tactile signals (IEC 61 310-1:2007); German
version EN 61310-1:2008). Berlin: Beuth Verlag
DIN EN 61310-2*VDE 0113-102:2008-09 Sicherheit von Maschinen; Anzeigen, Kennzeichen
und Bedienen; Teil 2: Anforderungen an die Kennzeichnung (IEC 61 310-2:2007); Deutsche Fas-
sung EN 61 310-2:2008 (Safety of machinery; Indication, marking and actuation; Part 2: Require-
ments for marking (IEC 61310-2: 2007); German version EN 61310-2:2008). Berlin: Beuth Ver-
lag
und Bedienen; Teil 3: Anforderungen an die Anordnung und den Betrieb von Bedienteilen (Stell-
teilen) (IEC 61310-3:2007); Deutsche Fassung EN 61 310-3:2008 (Safety of machinery; Indica-
tion, marking and actuation; Part 3: Requirements for the location and operation of actuators
(IEC 61310-3:2007); German version EN 61310-3:2008). Berlin: Beuth Verlag
DIN EN ISO 9000:2005-12 Qualitätsmanagementsysteme; Grundlagen und Begriffe (ISO 9000:
2005); Dreisprachige Fassung EN ISO 9000:2005 (Quality management systems; Fundamentals
and vocabulary (ISO 9000:2005); Trilingual version EN ISO 9000:2005). Berlin: Beuth Verlag
DIN EN ISO 9001:2008-12 Qualitätsmanagementsysteme; Anforderungen (ISO 9001:2008);
Dreisprachige Fassung EN ISO 9001:2008 (Quality management systems; Requirements
(ISO 9001:2008); Trilingual version EN ISO 9001:2008). Berlin: Beuth Verlag
DIN ISO 3864-2:2008-07 Grafische Symbole; Sicherheitsfarben und Sicherheitszeichen; Teil 2:
Gestaltungsgrundlagen für Sicherheitsschilder zur Anwendung auf Produkten (ISO 3864-2:2004)
(Graphical symbols; Safety colours and safety signs; Part 2: Design principles for product safety
labels (ISO 3864-2:2004)). Berlin: Beuth Verlag
DIN ISO 15226:1999-10 Technische Produktdokumentation; Lebenszyklusmodell und Zuord-
nung von Dokumenten (ISO 15226:1999) (Technical product documentation; Life cycle model
and allocation of documents (ISO 15226:1999)). Berlin: Beuth Verlag
DIN EN ISO/IEC 17025:2005-08 Allgemeine Anforderungen an die Kompetenz von Prüf- und
Kalibrierlaboratorien (ISO/IEC 17025:2005); Deutsche und englische Fassung EN ISO/
IEC 17025:2005 (General requirements for the competence of testing and calibration laboratories
(ISO/IEC 17 025:2005); German and English version EN ISO/IEC 17025:2005). Berlin: Beuth
Verlag
prEN ISO 7010:2008-01 Graphical symbols; Safety colours and safety signs; Safety signs used in
workplaces and public areas (ISO 7010:2003 including Amd 1:2006 and Amd 2:2007). Genf: ISO
ISO 5127:2001-10 Information and documentation; Vocabulary (Information und Dokumenta-
tion; Begriffe). Genf: ISO
ISO 5127-1:1983-12 Documentation and information; Vocabulary; Part 1: Basic concepts Bilin-
gual edition (Dokumentation und Information; Fachwörterverzeichnis; Teil 1: Grundprinzipien).
Zurückgezogen / Withdrawn 2001-10. Nachfolgedokument / Following document ISO 5127
ISO 7010:2011-06 Graphical symbols; Safety colours and safety signs; Registered safety signs
(Grafische Symbole; Sicherheitsfarben und Sicherheitszeichen; Registrierte Sicherheitszeichen).
Genf: ISOISO 8879:1986-10 Informationsverarbeitung; Text- und Bürosysteme; Verallgemei-
nerte normalisierte Erweiterungssprache (Information processing; Text and office systems; Stan-
dard Generalized Markup Language (SGML)). Genf: ISO
VDI 1000:2010-06 VDI-Richtlinienarbeit; Grundsätze und Anleitungen (VDI Guideline Work;
Principles and procedures). Berlin: Beuth Verlag
VDI 2519 Blatt 1:2001-12 Vorgehensweise bei der Erstellung von Lasten-/Pflichtenheften (Pro-
cedures for the compilation of tender and performance specifications). Berlin: Beuth Verlag
VDI 4500 Blatt 1:2006-06 Technische Dokumentation; Begriffsdefinitionen und rechtliche
Grundlagen (Technical documentation; Definitions and legal basics). Berlin: Beuth Verlag
VDI 4500 Blatt 2:2006-11 Technische Dokumentation; Organisieren und Verwalten (Technical
documentation; Organization and management). Berlin: Beuth Verlag
VDI 4500 Blatt 3:2006-06 Technische Dokumentation; Erstellen und Verteilen von elektroni-
schen Ersatzteilinformationen (Technical documentation; Producing and distributing electronic
spare parts information). Berlin: Beuth Verlag
Weiterführende Literatur / Rechenberg, P.: Technisches Schreiben (nicht nur) für Informatiker. München, Wien: Carl Hanser
Continuative literature Verlag, ISBN 10 3-446-40695-6
Hennig, J.; M. Tjarks-Sobhani: Wörterbuch zur technischen Kommunikation und Dokumentation.
Lübeck: Verlag Schmidt-Römhild, ISBN: 3-7950-0740-2
Lehner, F.: Software-Dokumentation: Berlin: Logos Verlag, ISBN: 3-89722-211-6
Juhl, D.: Technische Dokumentation. Berlin, Heidelberg: Springer-Verlag,
ISBN 10 3-540-23813-1
Hoffmann, W.; Hölscher, B.G.; Thiele, U.: Handbuch für technische Autoren und Redakteure.
Erlangen: Publics Corporate Publishing), ISBN 3-89578-187-8
Berlin, Offenbach: VDE Verlag GmbH, ISBN 3-8007-2674-2
Förster, H.-P.: Texten wie ein Profi. Frankfurt am Main: F.A.Z.-Institut, ISBN 3-927282-90-1