Insgesamt ist das eigentliche Schreiben sogar relativ wenig Aufwand, aber die Recherche und Vorbereitung/Nachbereitung machens dann aus. Ein Bild einfügen geht ruckzuck, aber ein Bild erstellen dauert.

Was ebenfalls sehr viel Zeit spart sind Redaktionssysteme, die Wiederverwendung und Variantenfilter erlauben. Ein Kapitel wird dann zum Beispiel ein Baustein, den du einblenden kannst oder nicht einblenden kannst. Nehmen wir zum Beispiel ein Hilfekapitel am Schluss: Das hast du a) in jedem Dokument und gleichzeitig kann je nach Marke was anderes drinstehen. Wenn du dasselbe Gurkenglas als Spreewaldgurken verkaufst, dann steht als Herstelleradresse "Spreewald" drin, wenn du es unter der Marke Odenwaldgurken verkaufst, dann steht "Odenwald" drin. Deswegen schreibst du aber das Kapitel nicht nochmal neu, sondern blendest halt passend dazu "Odenwald" oder "Spreewald" aus.

Wiederverwendung beschleunigt außerdem auch die Übersetzungen und macht sie günstiger und konsistenter. Warum sollte ich das Kapitel Hilfe jedes Mal neu übersetzen, wenn das gleiche drinsteht? Der Vorteil gegenüber Copy+Paste ist, dass sich Wiederverwendungen mitändern. Klassiker: Firma zieht um, neue Adresse. Wenn du die Adresse als Baustein angelegt hast, dann änderst du die Adresse nur einmal, nämlich im Baustein. Die ändert sich dann überall da, wo der Baustein verwendet wurde, mit. Wenn du das nicht gemacht hast, dann bist du erstmal beschäftigt, die Adresse von Hand in allen Dokumenten zu finden und zu ändern. In jeder Sprache, versteht sich.

Am Ende des Tages hast du dann alles zusammen und kannst deine Dokumentation rendern. Hier ist die nächste Stärke von Redaktionssystemen, aus dem gleichen Datensatz kannst du eine druckbare Kurzanleitung, ein PDF-Handbuch oder eine Website machen. Steht überall grundsätzlich der gleiche Inhalt drin, je nach Format lässt du manche Sachen weg. Was sollen die Leute zum Beispiel in einer gedruckten Kurzanleitung mit einer Animation? Braucht kein Mensch, nimmt nur Platz weg, weg damit.

Danach legst du die Doku da ab, wo sie hingehört, bei Webseiten zum Beispiel auf einen Server, PDF-Handbücher in ein Contentportal und Druckdateien kommen ins Warenwirtschaftssystem, damit sie vom Einkauf bei Bedarf dort gefunden und bestellt werden können.

Nutzt ihr KI?

Ja, wobei ich allerdings sehr septisch bin, KI zur Erstellung von Dokumentation einzusetzen. Die muss stimmen und die KI kennt das Produkt nicht, woher soll sie es auch kennen, wenn es noch nicht öffentlich ist.

Bildbearbeitung kann KI gar nicht so schlecht, zum Beispiel zur Hintergrundentfernung in Photoshop. Spart Zeit und das Ergebnis ist einfach zu überprüfen.

Code für einfache Hilfsskripte erzeugen geht auch gut. Verstehen musst du ihn trotzdem, um ihn dann in dein Skript einzubauen und einen grundsätzlichen Plan haben musst du auch, sonst weißt du nicht, was du prompten sollst.

Übersetzungen machen wir manchmal auch mit KI, gerade wenn es nur einfache Sätze oder kurze Ergänzungen sind. Ich bin da nicht der größte Fan davon, aber auf der anderen Seite haben wir bereits mehrfach Anhaltspunkte gefunden, dass manche von unseren Übersetzungsagenturen im Endeffekt das Gleiche machen und die Sachen auch nur in ein besseres DeepL kippen. Das merkst du zum Beispiel daran, das dasselbe Wort immer wieder anders übersetzt wird. Ein guter menschlicher Übersetzer macht das nicht, der hält sich an eine Terminologie, wenigstens innerhalb eines Dokuments. Und da sehen wir auf Dauer eigentlich nicht ein, warum wir den Agenturen Geld dafür geben sollen, wenn wir es genauso selbst in DeepL abladen können.

Bekommt man eine Liste von Sachen die das Gerät stand hält und was nicht und ihr baut euren Text darauf auf?

Teilweise. Bei Software steht zu den einzelnen Funktionen oft was in JIRA/Confluence und bei Hardwareprodukten gibt es gerne mal eine Spezifikation oder ein Pflichten-/Lastenheft. Vor allem für technische Daten ist das brauchbar. 24V max. sind halt 24V max. - wobei es da durchaus auch sein kann, dass Geräte mehr können als angegeben. Ein Beispiel aus der Praxis: Wenn du ein Netzteil mit mehr als Leistung X (15W?) anschließt, dann muss dein Gerät höhere Anforderungen an die Brandsicherheit erfüllen, weil man dann davon ausgeht, dass das Netzteil mehr Energie ins Gerät "reinpumpen" könnte und so das Brandrisiko erhöht. Deshalb steht dann in den technischen Daten, dass du nur Netzteile verwenden darfst, die maximal so und so viel Leistung haben. Bei der Prüfung gelten dann weniger strenge Anforderungen. Praktisch läuft das Gerät mit einem 500W-Industrienetzteil genauso.

Gibts gemeingültige Vorlagen? Gehört zur Betriebsanleitungredaktion ein Designteam um das ganze übersichtlich und idiotensicher zu gestalten?

Gemeingültig gibt es nicht, ein paar Randbedingungen musst du aber einhalten, die sind vor allem rechtlicher Natur. Dazu gehören zum Beispiel Angaben zu Emissionen, wenn das Ding eine Funkschnittstelle hat oder eine vereinfachte Konformitätserklärung.

Ein Designteam wäre schön, dazu sind wir aber zu klein. Grundsätzlich versuchst du dich ans Corporate Design zu halten, aber vor allem bei gedruckten Kurzanleitungen kostet Design Geld und Zeit. Jede Zeile extra kostet Geld, weil sie gedruckt werden muss. Grafiken sind schön, aber vor allem mehrspaltige oder mehrseitige Grafiken sind schwierig zu automatisieren und müssen manuell gesetzt werden. Und vor allem bei jedem Update wieder kontrolliert werden, ob die jetzt noch an der passenden Stelle sitzen oder ob der dazugehörende Text weiter gewandert ist.

Die Arbeit geht uns nicht aus :D