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

Konzeptionelles Arbeiten in der Technischen Dokumentation: Wider die Linearität

03.03.201108.01.2022

Die Technische Dokumentation verlangt Papier. Sie schreit nach Papier, wenn es um die „Unterlagen“ geht, sie spuckt Papier aus, wenn es um die Ausgabe geht. Wir Technischen Redakteure beginnen eine Technische Dokumentation immer mit einem tatsächlichen leeren Blatt Papier oder einem Bildschirm, auf dem ein leeres Blatt Papier dargestellt wird. Dann fangen wir an zu schreiben.

Weblinks

  • Schreibkompetenz
  • Semantisches Netz

Zunächst schreiben wir alles auf, was wir von unseren Informanten erfahren. Wir lachen mit Ihnen über die dummen Anwender, schütteln den Kopf über die Bediener, die es auch nach der dritten Erklärung immer noch nicht begreifen, in welche Richtung der Schalter zeigen soll. Und wir fühlen uns genötigt, allen Anwesenden zu demonstrieren, dass wir nicht so sind wie die Benutzer, dass wir mit den geistigen Urhebern des Produkts auf Augenhöhe stehen, das Produkt begreifen und unsere Arbeit wertvoll ist. Vor allem für den Auftraggeber.

Wir stöhnen über Auftraggeber, die uns erklären, dass sie eine Anleitung sowieso nicht lesen. Sie kennen ja schließlich das Produkt. Sie haben es seit seiner Entstehung in den Köpfen und auf dem Reißbrett begleitet. Sie sind seine Väter und entsprechend stolz darauf.

Die Dokumentation als Roman

Diesen Standpunkt und diese Sichtweise machen wir uns zu eigen: Wir leben mit dem Produkt, wir vollziehen jeden Entwicklungsschritt geistig nach, wir kauen die Eigenschaften des Produkts durch und entdecken es für uns selbst. Und das sieht man den Dokumentationen dann an. Unsere Texte und Bilder spiegeln jenes museale Interesse wider, das man auch den Werken großer Meister entgegen bringt: „Toll! Wie haben die das nur gemacht? Und hier, sieh mal das Detail dort in der Ecke. Toll!“ …

Wir schreiben unsere Dokumentation über die Lebensdauer des Produkts, so wie man einen Roman über die Wanderjahre des Lehrburschen schreibt, bis er zum Meister wird (oder das Produkt an den Kunden geliefert wird). Und ebenso wie ein Romanschreiber wollen wir den Leser mitnehmen auf eine Reise durch das Produkt, wollen ihn begeistern und animieren zum Entdecken. Sehr lobenswert. – Und so ziemlich an der Realität vorbei.

Der Benutzer des Produkts legt sich die Dokumentation nämlich gewöhnlich nicht auf den Nachttisch, um vor dem Schlafengehen noch mal schnell die nächsten Seiten zu lesen. Das macht er bei einem Roman, der ist linear aufgebaut und Jeder, der ein paar Seiten überspringt, läuft Gefahr, die Schlüsselstelle zu verpassen. Bei einer Technischen Dokumentation macht er das nicht. Eine Technische Dokumentation besteht nicht aus linear angeordneten Informationen (das ist nur bei einzelnen Handlungsfolgen der Fall), sie besteht aus assoziativen Informationsknoten.

Selbstbeobachtung als Ausgangspunkt

Beobachten wir uns doch einmal selbst: Wann lesen wir eine Dokumentation? Sogar in unserer eigenen Dokumentation springen wir gezielt zu den Stellen, die geändert werden sollen oder die wir benötigen. Dazu benutzen wir ein Inhaltsverzeichnis. (In Romanen gibt es das häufig gar nicht, was auch ein Zeichen für den linearen Aufbau ist, denn ein Roman braucht keine Kapitelübersicht.) Oder wir benutzen Querverweise. (Das ist in Romanen ebenso selten, denn er ist ja linear: Die folgende Seite baut immer auf den Inhalt der vorherigen Seiten auf.)

Im realen Leben machen wir das auch: wir suchen den Schlüssel für die Haustür und nicht den Bauplan für das Haus. Für jede Information setzen wir stillschweigend voraus, dass sie existiert, nicht dass wir sie lesen müssen. Wir verwenden Informationen assoziativ: Wir benutzen sie dann, wenn wir sie brauchen und hangeln uns bei Bedarf von einem Knoten zum nächsten.

Wenn wir die gesuchte Information nicht finden, eskalieren wir auf die nächste Stufe: Ausgehend von den Informationen die wir gefunden haben, entscheiden wir, welche Informationen noch fehlen oder ergänzt werden müssen. Dann benutzen wir ein Glossar oder versuchen anhand des Inhaltsverzeichnisses (das ja auch nur eine Sammlung von Querverweisen ist) oder von Querverweisen zu den weiterführenden Informationen zu gelangen. Wir arbeiten informations-ökonomisch.

Anwendersicht

Warum aber tun wir so, als ob unsere Leser Zeit haben, einen Roman zu lesen? Warum schreiben wir nicht assoziativ? Warum verkneifen wir uns die strukturelle Vorarbeit, die verfügbaren Informationen in assoziative Häppchen zu zerlegen und diese miteinander zu verbinden (beispielsweise mit Querverweisen)?

Der Schritt von der linearen zu einer assoziativen Dokumentation ist nicht einfach, gewiss. Er setzt ein hohes Maß an Eigenbeobachtung voraus und auch eine abstrahierende und strukturierende Vorgehensweise. Statt einfach drauflos zu tippen wie eine technisch vorgebildete Schreibkraft müssen wir erst sortieren, gewichten, einordnen, priorisieren, visualisieren. Kurz: wir müssen unserem Beruf angemessen denken.

Wir müssen in der Lage sein, unsere Sicht der Dinge zu hinterfragen, sie aber auch zu vertreten und umzusetzen. Wir müssen berechtigte Kritik einarbeiten und unser Modell der Benutzerführung zu erweitern. Wir müssen uns die Sicht des Anwenders zu eigen machen, den wir nicht kennen, statt die Sicht des Herstellers, der uns gegenüber sitzt. Wir müssen beitragen, nicht unbesehen weitergeben. Wir sind Technische Redakteure und als solche Spezialisten für die Informationsvermittlung.

Oder wir finden uns damit ab, einfach eine teurere Schreibkraft zu sein.

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 …
dokumentation RedaktionstrukturtechdokTechnische Dokumentation

Beitragsnavigation

Previous post
Next post

Related Posts

dokumentation

Gehirngekrakel: von der Idee zur Zeichnung

25.11.201703.11.2018

Kreativität sei 10% Inspiration und 90% Transpiration, hat mal Thomas Edison behauptet – stimmt auch ungefähr. Herr Edison konnte zwar alles mögliche, aber als Technischer…

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
appseits Fibonacci-Kurve

Kritzeln auf Tafeln, Teil 7: Richtiges konstruieren mit Shapr3D

11.07.202013.03.2022

OK, das ist jetzt nix mehr für den Alltagsgebrauch eines Normalsterblichen. 😉

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

Redaktionssysteme: Es ist aufgetragen!

03.04.201509.03.2018

Lehnen wir uns einmal kurz zurück und betrachten den bisherigen Stand: Wir haben alle Daten in das System migriert, haben die Redundanz weitgehend beseitigt, indem…

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 …
Pages: 1 2
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:

  • Zero
  • iCloud: Heiter bis wolkig
  • Kritzeln auf Tafeln, Teil 7: Richtiges konstruieren mit Shapr3D

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

  • Zero
  • iCloud: Heiter bis wolkig
  • Kritzeln auf Tafeln, Teil 7: Richtiges konstruieren mit Shapr3D

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