Skip to content
readit
readit

leben, technik und kommunikation

  • werkstatt
    • appseits
    • dokumentation
    • software
    • praxistipps
    • referenzen
  • thinkware
    • Gesellschaft
    • public
    • Reisebilder
    • Lyrik
  • Nach­richt an mich
    • Datenschutz
    • Impres­sum
readit
readit

leben, technik und kommunikation

Auf Kollisionskurs

27.12.201703.11.2018

Endlich erobern sich Standardisierung und Modularisierung in der Technischen Dokumentation den ihnen gebührenden Platz. Das immer noch weit verbreitete „Copy & Paste“ ganzer Dokumentationen einschließlich des anschließenden Aufwands verliert. Endlich.

In den letzten Jahren verlieren die klassischen Publikationsmethoden in der technischen Dokumentation zunehmend an Boden: Wer heute noch seine zunehmend komplexeren Informationen auf die traditionelle Weise herstellt, indem er erst eine Dokumentation für ein Produkt aufbaut und dieses dann vervielfältigt und anpasst, der wird schon nach kurzer Zeit mit explodierenden Kosten bestraft: jedes Dokument wird nach der Anpassung neu übersetzt, jede Anpassung muss nachvollzogen werden, jede Änderung der Spezifikation zieht ständige Anpassungen in allen weiteren betroffenen Dokumenten nach sich. Eine 1:n-Beziehung zwischen der Produktänderung und der Dokumentanpassung ist damit unausweichlich – mit allen Konsequenzen bei Personalaufwand und Fehlerhäufigkeit.

Denn im Gegensatz zur Tatsache, dass der deutsche Sondermaschinenbau hochgradig flexibel auf Kundenwünsche reagieren kann, weil er nur Einzelanfertigungen produziert, schreibt man auch dort nicht jedesmal die Dokumentation neu, sondern nutzt – per Copy & Paste – bereits vorhandene Dokumentationsbausteine: Hier ein Abschnitt, dort ein Bild oder eine Tabelle. Und die Firmenadresse ist sowieso gleich bis auf die neue Telefonnummer …

Der Sondermaschinenbau ist nur das Extrembeispiel, denn selbst dort zeigt die Erfahrung, dass kein Mensch das Rad gerne zweimal erfindet und sich der betriebswirtschaftliche Gewinn erheblich verbessert, wenn man durch Wiederverwendung von Bauteilen in eine Kleinserienfertigung übergeht, die nur an vorher definierten Stellen anpassbar ist.

Warum macht man das dann nicht in der Dokumentation auch?

Das macht man auch, und zwar zunehmend mit Redaktionssystemen oder anderen Werkzeugen, die eine Modularisierung und Wiederverwendung von Informationsmodulen ermöglichen. Ausgehend von den gleichen Überlegungen wie bei der Produktion, dass nämlich die Produkte modular aufgebaut sind, wird mit Redaktionssystemen diese Modularität nachempfunden. ((Sie kann nicht identisch sein, auch wenn Produktmanager das manchmal denken, da die Bauteile und ihre Einbindung in das Gesamtsystem „Produkt“ nicht deckungsgleich sind mit der jeweils vorhandenen Information und ihrer Verwendung im Gesamtsystem „Dokumentation“.))

 

Schweres Gerät für große Projekte

Redaktionssysteme sind wie Sattelschlepper: es gibt fast nichts, was man mit ihnen nicht verarbeiten kann. Sie transportieren Informationen jeder Größe auf jedem Weg zum Nutzer. Zuverlässig. Allerdings nicht billig und „mal eben so“, denn sie erfordern einen relativ großen Planungsaufwand zur Strukturierung der Information (siehe auch Redaktionssysteme: Leidensdruck oder Knopfdruck?) ebenso wie zur Einarbeitung und Pflege. Sie sind langfristig immer eine Option, wenn Informationen drohen, durch ständige Anpassungen, hohe Produktvarianz, Globalisierung und Pflegeaufwand unter die Räder zu geraten. Projekte sind nicht deshalb „groß“, weil sie viele Seiten (auch im übertragenen Sinn) besitzen, sondern weil zahlreiche Faktoren zum Gelingen beitragen müssen – Faktoren, die nur zu einem geringen Teil mit dem Produkt selbst zu tun haben.

Es gibt aber einen weiteren Aspekt, der – und hier passt das Bild auch – nicht zwangsläufig aus einer vielseitigen, skalierbaren und pflegeleichten Dokumentation auch eine gute Dokumentation macht: Redaktionssysteme sind nämlich eine technische Lösung für ein betriebswirtschaftlich-technisches Problem. Dem Nutzer der Dokumentation ist es weitgehend egal, ob und mit welchem Redaktionssystem seine Information erstellt und produziert wurde – der Nutzer will die richtige Information zum richtigen Zeitpunkt („Wie quittiere ich eine Fehlermeldung an meiner Maschine?“ – „Wo schließe ich meinen Beamer an?“ – „Warum kann ich das Batteriefach an meiner Kamera nicht öffnen?“). Hier besitzen Redaktionssysteme eine systemimmanente Schwachstelle: sie sind auf die effiziente Massenproduktion ausgelegt, nicht auf die individualisierte Informationsvermittlung.

Wenn Technikredakteure vom „Nutzer“ im Singular sprechen, ist damit eigentlich immer eine Zielgruppe gemeint, die der Redakteur sich selbst vorstellt oder auf die sich die Redaktion geeinigt hat. Dazu leisten Redaktionssysteme einen unersetzlichen Beitrag, indem sie auf strikte Konsistenz achten. Ob Terminologie oder Satzbau, ob Übersetzungskongruenz oder Layout – der Redakteur kann (und darf) nichts selbst „individualisieren“.

Das ist gut für die Dokumentation und die Kosten, aber ist es auch gut für den Nutzer?

Der Nutzer sieht ja nicht, dass sein Dokument in 24 Sprachen auf allen Kontinenten mit der identischen Information zur Verfügung steht, er hat nur ein Produkt und ein Dokument. Er weiß nichts vom hohen logistischen Aufwand, der dahinter steckt, die von ihm voraussichtlich benötigte Information („Heiße Oberfläche! Finger weg!“) verständlich und situativ passend bereitzustellen.

Das soll er auch nicht.

Der Aufwand zur Individualisierung muss aber teilweise getrieben werden, vor allem, wenn es sich um Endbenutzer-Produkte handelt, also Produkte, für die kein Fachwissen erforderlich ist. Denn während sich der Technikredakteur im Maschinen- und Anlagenbau darauf verlassen kann, dass seine beschriebenen Produkte nur von „Fachpersonal“ benutzt werden, hat er es im privaten Bereich mit Laien zu tun. Laien, die nicht wissen, in welche Richtung man eine Schraube drehen muss, um sie zu lösen. Laien, die nicht wissen, dass man ein elektronisches Gerät nicht unter dem Wasserhahn reinigt oder den Hamster in der Mikrowelle trocknet. Das ist nicht Desinteresse, das ist einfach die Begrenztheit des menschlichen Verstands – so wie auch hochbezahlte Ingenieure Probleme damit haben können, sich ein Rezept für Hefeteig zu merken.

Auf der anderen Seite

Der hochgradig effizienten Dokumentationserstellung mit zahlreichen Publikationskanälen, einem Stab an Spezialisten, Experten und ausgeklügelten Prozessen steht ein einfacher Nutzer gegenüber, der einfach nur wissen will, wo der blöde Einschaltknopf ist.

Es ist eine seltene und nicht gerade leichte Kunst, den vermeintlich trivialen Ansprüchen eines Nutzers mit einem Redaktionssystem beizukommen, das dafür eigentlich nicht gemacht ist. Es kostet einen enormen Aufwand, dieses Kunststück zu bewerkstelligen, sowohl konzeptionell als auch inhaltlich.

Diesen Aufwand kann sich aber nicht jeder Produzent leisten, denn zu den Kosten für ein Redaktionssystem und den Schulungen sowie Anpassungen der Technik kommt der konzeptionelle und inhaltliche Aufwand für die „Individualisierung“ dazu. Berechtigterweise stellt sich dadurch die Frage, ob sich ein Redaktionssystem in einem solchen Fall überhaupt lohnt – oder ob es nicht auch „eine Nummer kleiner“ auch geht. Damit spart man sich dann zwar nicht den konzeptionellen und inhaltlichen Aufwand, aber zumindest die Kosten für die Einführung und Pflege eines Redaktionssystems.

Das Dilemma „Geld oder Nutzer“ lässt sich nur im Einzelfall beseitigen – und auch dann nur temporär. Denn der Nutzer steht da wie eine Felswand, auf die ein Fahrzeug zufährt. Er lässt sich nicht verschieben oder ändern. Den Schaden hat immer das Fahrzeug – egal wie groß es ist.

Teilen mit:

  • Auf Mastodon teilen (Wird in neuem Fenster geöffnet) Mastodon
  • Auf WhatsApp teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Einen Link per E-Mail an einen Freund senden (Wird in neuem Fenster geöffnet) E-Mail
  • Auf Bluesky teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Drucken (Wird in neuem Fenster geöffnet) Drucken
  • Auf LinkedIn teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Auf Telegram teilen (Wird in neuem Fenster geöffnet) Telegram
  • Auf Pinterest teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
technische dokumentation ModularisierungRedaktionssystemUsability

Beitragsnavigation

Previous post
Next post

Related Posts

praxistipps

Aufgabenverwaltung: Work smarter, not harder

13.12.202531.12.2025

Aufgabenmanagement ist super: alleine das gute Gefühl, die Aufgaben und anstehenden Tätigkeiten im Griff zu haben, seinen beruflichen Alltag unter Kontrolle zu haben – und…

Teilen mit:

  • Auf Mastodon teilen (Wird in neuem Fenster geöffnet) Mastodon
  • Auf WhatsApp teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Einen Link per E-Mail an einen Freund senden (Wird in neuem Fenster geöffnet) E-Mail
  • Auf Bluesky teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Drucken (Wird in neuem Fenster geöffnet) Drucken
  • Auf LinkedIn teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Auf Telegram teilen (Wird in neuem Fenster geöffnet) Telegram
  • Auf Pinterest teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More
praxistipps yellow jigsaw puzzle piece

MadCap Flare und die Variablen

05.02.202310.02.2023

Dieser Beitrag ist eigentlich nur was für Techies und User der Software „Flare“ von MadCap. Und vielleicht auch für Technikredakteur:innen, die sich mit dem Gedanken…

Teilen mit:

  • Auf Mastodon teilen (Wird in neuem Fenster geöffnet) Mastodon
  • Auf WhatsApp teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Einen Link per E-Mail an einen Freund senden (Wird in neuem Fenster geöffnet) E-Mail
  • Auf Bluesky teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Drucken (Wird in neuem Fenster geöffnet) Drucken
  • Auf LinkedIn teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Auf Telegram teilen (Wird in neuem Fenster geöffnet) Telegram
  • Auf Pinterest teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More
dokumentation

PDF: Der Dokumentations-Abfall

22.03.201704.04.2017

Immer wieder wurde in den letzten Jahren zuerst das Ende der Papierdokumentation und dann das Ende des PDF-Datenformats vorhergesagt. Zu Recht. Allerdings ist der Zeitpunkt…

Teilen mit:

  • Auf Mastodon teilen (Wird in neuem Fenster geöffnet) Mastodon
  • Auf WhatsApp teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Einen Link per E-Mail an einen Freund senden (Wird in neuem Fenster geöffnet) E-Mail
  • Auf Bluesky teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Drucken (Wird in neuem Fenster geöffnet) Drucken
  • Auf LinkedIn teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Auf Telegram teilen (Wird in neuem Fenster geöffnet) Telegram
  • Auf Pinterest teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More

Sonst noch was:

  • Produktiver als jeder Montag: Aufgabenverwaltung mit monday.com
  • Aufgabenverwaltung: Work smarter, not harder
  • SVG zähmen leicht gemacht
  • Giro D'Etruria: Toskana und die Emilia Romagna 2025
  • MadCap Flare und Atlassian Confluence: das Powercouple
  • JIRA: Das Monster der Aufgabenverwaltung
  • Radfahren im Bayerischen Wald: Unterwegs am 49. Breitengrad
  • Tools for fools
  • Kommunikation kanalisieren
  • Onlinehilfen: Form follows function
  • Taskworld, der Kopfschmerzvermeider
  • Japan parforce

Beliebt:

  • Kinomap richtig einstellen
  • Internetnutzung: Wir glotzen auf Waschmaschinen
  • Schattenboxen
  • In Simplicity We Trust
  • Zur Migration
  • Digitale Literatur: Märchen, reloaded.
  • Es waren zwei Königskinder
  • PDF Expert: Der Hürdenläufer
  • Verhoben
  • Evernote – der Überallnotizblock

Klima und Umwelt

  • Klima vor Acht Das Ziel von KLIMA° vor acht ist es, Fernsehsender zu überzeugen, wissenschaftlich fundierte Klimaberichterstattung zu produzieren, die täglich zur besten Sendezeit ausgestrahlt wird und so viele Zuschauer wie möglich erreicht.

Blog via E-Mail abonnieren

Gib deine E-Mail-Adresse an, um diesen Blog zu abonnieren und Benachrichtigungen über neue Beiträge via E-Mail zu erhalten.

Gern gelesen

  • Kinomap richtig einstellen
  • Internetnutzung: Wir glotzen auf Waschmaschinen
  • Schattenboxen
  • In Simplicity We Trust
  • Zur Migration
  • Digitale Literatur: Märchen, reloaded.
  • Es waren zwei Königskinder
  • PDF Expert: Der Hürdenläufer
  • Verhoben

Hinweis

Es bestehen zu keinen der in diesem Blog genannten Unternehmen und Personen geschäftliche Beziehungen in der Form, dass ich für Werbung oder Vermarktung Geld oder geldwerte Zuwendungen erhalte.

Rechtliches

  • Datenschutz
  • Impressum
Datenschutz und Cookies: Diese Website verwendet Cookies. Wenn du die Website weiterhin nutzt, stimmst du der Verwendung von Cookies zu.

Weitere Informationen, beispielsweise zur Kontrolle von Cookies, findest du hier: Cookie-Richtlinie
©2026 readit | WordPress Theme by SuperbThemes
%d