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

Die Steigeisen des Informationsarchitekts, Teil 2

11.03.201815.07.2020

Die gute Nachricht zuerst: die Anforderungen und die Welt wandeln sich. Die schlechte: wir kommen manchmal nicht mehr mit. Da geht es dem Technikredakteur kaum anders als vielen Bewohnern der industrialisierten Länder. Das Unangenehme daran ist die Erkenntnis, dass sich der Wandel nicht aufhalten lässt. Auch nicht in der Technikredaktion…

Also geht es darum, wie man ihn nutzt. Denn seien wir ehrlich: sich gegen Wandel zu sperren, erhöht die Frustration, steigert aber sicher nicht den Erfolg. ((Abgesehen davon, dass wir Menschen zu den anpassungsfähigsten Lebewesen gehören, wäre es auch ein völlig sinnloses Unterfangen, auf einem inadäquaten Standpunkt zu beharren – der Wandel interessiert sich nicht für unsere Meinungen. Er passiert.))

Der Technikredakteur als Informationsarchitekt

Der Wandel – und damit der Anpassungsdruck – geht auch am Technikredakteur nicht vorbei. Natürlich gibt es immer noch Branchen, die eine gedruckte PowerPoint-Präsentation als technisches Dokument bezeichnen, und es gibt immer noch Kollegen, die dies mit sich machen lassen. Aber beide sind eine rapide dahinschwindende Spezies: Technikredakteure, die nur noch darauf bedacht sind, die wenigen Jahre bis zum Ruhestand ohne Veränderung zu überstehen, und Unternehmen, die verzweifelt versuchen, dokumentationstechnisch den Hals über Wasser zu halten.

Wie aber geht der Redakteur damit um? Noch mehr Schulungen? Noch mehr Veranstaltungen zum Thema „Industrie 4.0“, „CMS“, „Hybride Dokumentation“ oder ähnlichen Buzzwords, die die Erlösung vom redaktionellen Selektionsdruck versprechen? Noch mehr Hard- und Software, um die sich die IT-Abteilung kümmern muss? Noch mehr unterschiedliche Prozesstechniken, um schneller zu Ergebnissen zu kommen?

Wer schon mal in den Bergen zu Fuß unterwegs war zum Gipfelkreuz, der weiß, dass „schneller laufen“ nicht gleichbedeutend ist mit „früher ankommen“.

Wir sollten daher einmal über unsere Ausrüstung nachdenken und die Frage, ob sie uns auch zum Ziel führt – und vor allem, wie eigentlich unser Weg aussieht. Stark vereinfacht besteht unsere Tätigkeit nämlich mittlerweile aus drei Prozessschritten:

  • Sammeln. Das ist die klassische Recherche: welche Informationen haben wir, welche brauchen wir und woher kommt sie?
  • Strukturieren. Hier wird es schon schwieriger, denn einfach nur Informationen wie Schaltpläne und Wartungsintervalle oder Produktinformationen in ein Dokument zu kippen, das sich dann Dokumentation nennen soll, genügt bei weitem nicht mehr – weder den rechtlich-normativen Anforderungen noch denen der Benutzer (und damit der zahlenden Kunden).
  • Visualisieren. Ja, auch das gehört dazu. Und im etwas weiteren Sinn ist die Dokumentation selbst eine Visualisierung der strukturierten Information. Denn ob wir nun Tabellen oder Grafiken, Diagramme oder Listen „aufs Papier oder den Bildschirm malen“: Wir visualisieren dass, was der Hersteller an Informationen bereitstellt und kommunizieren sie an den Benutzer oder Kunden. Und wir benutzen auch Visualisierung, um Prozesse zu verstehen oder verständlich zu machen.

Wer sich im Metier des Technikredakteurs auskennt, weiß, dass diese drei Punkte nicht strikt nacheinander abgearbeitet werden können: oft ergeben sich aus einer Ergänzung der Informationssammlung weitere Punkte für die Struktur, die dann natürlich auch zu einer Änderung der Visualisierung führen. ((Die Struktur kann tatsächlich ein stumpfes Inhaltsverzeichnis sein, eine Gliederung sozusagen. Mittlerweile aber ähnelt sie jedoch eher einer Dokumentationssammlung, also einer Inhaltsübersicht unterschiedlicher Inhaltsverzeichnisse, die aber nicht linear (auf Papier oder PDF), sondern auch als „Mindmap“ vorliegen kann. Eine Struktur kann somit vertikal und horizontal Informationen enthalten – wie eine Tabelle.))

Der Technikredakteur muss in allen drei Schritten des Prozesses Zuhause sein, um ein zufrieden stellendes Ergebnis liefern zu können. Meist schwächeln wir Technikredakteure nämlich am Punkt in der Mitte: der Strukturierung. Wir sind in der Lage, unsere Informationen zu sammeln und zu visualisieren, aber dabei überspringen wir oft den Punkt, der aus dem Abtippen und Aufhübschen der Information eine vernünftige und vor allem nachhaltige technische Dokumentation macht.

Nachhaltige Dokumentation

Auch wenn der Begriff der „Nachhaltigkeit“ politisch vorbelastet ist: Nachhaltigkeit in der Dokumentation ist das beste Mittel für langfristige Kundenbindung und eine gute Auftragslage.

Nachhaltigkeit macht glückliche Kunden und glückliche Kunden machen Chefs glücklich und die Wurstscheiben dicker.

Was aber bedeutet das in der Dokumentation?

Es beginnt damit, dass keine Dokumentation eine Insel ist: sie ist immer in einen Produktionsprozess eingebunden. Sie ist abhängig von einem Produkt in einer (oder mehrerer Varianten) und einer Version. Sie ist eingebunden in einen Übersetzungsprozess, einen Korrektur- und Freigabeprozess – und in einen Publikationsprozess. Sie muss skalierbar sein und anpassbar. Diese Faktoren bereits ab der ersten Dokumentation zu berücksichtigen, zu gewichten und in den Erstellungsprozess einzutakten, ermöglicht es dem Redakteur, bei der Dokumentation einer neuen Version und einer anderen Variante oder einem anderen Produkt um Größenordnungen schneller zu werden – und den Zeitgewinn für eine qualitative Verbesserung zu nutzen.

Sammeln

Für das Sammeln der Informationen benötigt man kein Tool, das eine bestimmte Form vorgibt, in die die Information gebracht werden muss (Word beispielsweise, oder gar Excel), sondern ein Tool, in das sich alle Informationen zunächst unsortiert einfügen lassen. OneNote ist so ein Kandidat. Oder Evernote (siehe auch Evernote: Anmelden zur Mitarbeit). Beide Tools eignen sich hervorragend auch, um während einer Besprechung Notizen zu sammeln und sogar zu malen. Oder um die Bilder auf dem Whiteboard abzufotografieren und zu kategorisieren.

Wichtig ist vor allem, dass die Notizen sich durchsuchen und verschlagworten lassen (beispielsweise in „Notizbücher“). Charmant ist bei beiden Tools, dass sie auf mehreren Plattformen und Betriebssystemen vorhanden sind. Wer also über einen Office 365-Account oder ein Evernote-Konto verfügt (und eine IT-Abteilung, die ihr Geld auch wert ist ((Selbstständige sind hier besser dran, die müssen sich nicht ihre Knie in der IT wund scheuern…)) ), der benötigt nur ein Tablet und gegebenenfalls einen Stift – und ist für die komplette Informationsrecherche bereits ausgerüstet.

Strukturierung

Hier sind nun iOS/macOS-Nutzer deutlich im Vorteil, denn ausgereifte Tools zur Strukturierung sind für Windows eher dünn gesät. Natürlich kann man in Word den Gliederungsmodus verwenden, dieser ist allerdings bei weitem nicht so ausgereift und flexibel wie OmniOutliner (siehe auch OmniOutliner 4: Wie sonst wenn nicht mit Gerüst?). In den neuen Versionen für iOS und macOS hat die Software nochmals deutlich an Funktionsumfang und Nutzbarkeit zugelegt, denn die neue Filterfunktion erlaubt es, auch in langen und verschachtelten Strukturen die Übersicht zu behalten.

Auch dieses Tool lässt sich nutzbringend auf einem iPad einsetzen, denn die Daten können im Hintergrund mit einem Server abgeglichen werden und stehen dann 1:1 auf dem Laptop oder stationären Rechner zur Verfügung – dazu allerdings benötigt man einen Mac.

Visualisierung

OK, das ist nun der Bereich, in den man nur als Selbstständiger vordringen kann: ein iPad mit Apple Pencil und OmniGraffle (zu OmniGraffle, siehe auch OmniGraffle 6: Damit die Ideen nicht ausgehen). Zwar gibt es auch in Deutschland moderne Unternehmen, die dies ihren Mitarbeitern genehmigen, um produktiv arbeiten zu können, in der Technikredaktion ist das aber extrem selten. (Man könnte zwar auch ein Microsoft-Tablet mit Stift und Visio benutzen, aber auch dies findet man nicht häufig.)

Leider.

Gerade im Bereich der Konzeption und der Prozessdefinitionen gibt es kaum ein effektiveres Instrument als eine grafische Darstellung von Relationen und Abhängigkeiten. Dokumentationen, die per Hyperlink oder Querverweis über mehrere Plattformen (Online/Offline) miteinander verknüpft sind und aufgrund ihrer modularen Struktur dazu neigen, unübersichtlich zu werden, lassen sich per Visualisierung auf ein verständliches Maß „eindampfen“.

Statt ein Whiteboard zu bemalen, bis aufgrund unterschiedlicher Malkünste und Strichfarben kein Beteiligter mehr weiß, was hier eigentlich dargestellt wurde, ist es mit einem Visualisierungstool ein Leichtes, Informationssammlung und -strukturierung darzustellen.

Schlusswort

Alle drei vorgestellten Prozessschritte haben spezifische Anforderungen an das dafür geeignete Werkzeug. Alle drei Prozessschritte sind aber notwendig, um eine Dokumentation effizient zu erstellen und zu pflegen. Die Gefahr, gerade angesichts wachsender Anforderungen an die Dokumentation und den Prozess auszurutschen und zu verunglücken, wird nicht geringer. Umso besser, wenn der Technikredakteur als Informationsarchitekt die geeigneten Steighilfen kennt und nutzt.


Bild oben im Overlay: Historische Steigeisen für die Mahd sehr steiler Wiesen und für die Flößerei (https://de.wikipedia.org/wiki/Steigeisen)

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
dokumentation software technische dokumentation tools Work OmnigraffleOmnioutlinerStrukturierung

Beitragsnavigation

Previous post
Next post

Related Posts

dokumentation

CSS mit Flare: Sieht gut aus

29.12.201621.02.2022

Weitab von Produktivitätsdruck und Produktionseffizienz beschäftigen wir uns heute mit einer Sache, die dann „von alleine“ laufen muss, wenn der Stresspegel steigt: Layout mit MadCap…

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More
praxistipps

Icons mit Adobe Illustrator: The Elephant in the Room

10.01.201917.01.2019

Beim Erstellen von Icons sollte man arbeiten wie die Profis.

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu teilen (Wird in neuem Fenster geöffnet) Pinterest

Gefällt mir:

Gefällt mir Wird geladen …
Read More
redaktion

Tech docs don’t sell

30.03.201818.04.2018

Wenn sich schon Technische Dokumentation schlecht verkauft, müssen wir es nicht auch tun.

Teilen mit:

  • Zum Teilen auf Mastodon klicken (Wird in neuem Fenster geöffnet) Mastodon
  • Klicken, um auf WhatsApp zu teilen (Wird in neuem Fenster geöffnet) WhatsApp
  • Klicken, um einem Freund einen Link per E-Mail zu senden (Wird in neuem Fenster geöffnet) E-Mail
  • Klicken, um auf Bluesky zu teilen (Wird in neuem Fenster geöffnet) Bluesky
  • Mehr
  • Klicken zum Ausdrucken (Wird in neuem Fenster geöffnet) Drucken
  • Klick, um auf LinkedIn zu teilen (Wird in neuem Fenster geöffnet) LinkedIn
  • Klicken, um auf Telegram zu teilen (Wird in neuem Fenster geöffnet) Telegram
  • Klick, um auf Pinterest zu 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:

  • Impressum
  • Das dürfte fast für einen alternativen Nobelpreis reichen …
  • Fisch oder Auto?
  • Lästig
  • Ein Engel.
  • La Loire à Vélo
  • Munen musô
  • Kriminell - krimineller - Liechtenstein
  • Referenzen
  • Sesselfurzer, Episode 1

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

  • Das dürfte fast für einen alternativen Nobelpreis reichen …
  • Fisch oder Auto?
  • Lästig
  • Ein Engel.
  • La Loire à Vélo
  • Munen musô
  • Kriminell - krimineller - Liechtenstein
  • Sesselfurzer, Episode 1
  • Internetnutzung: Wir glotzen auf Waschmaschinen

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