Lösung 04 · Technische Dokumentation

Modulare Betriebs­anleitungen: einmal ändern, in jeder Dokumentation aktuell

Mit myDoku pflegen Sie Standardtexte an einer Stelle statt in jeder Datei. Eine Korrektur am Sicherheitshinweis kommt in den Betriebsanleitungen an, in denen er steht, in jeder Sprache. Und Sie sehen vorher, welche das sind.

Erstgespräch +49 2362 974097-2 So funktioniert es
Eine Betriebsanleitung aus Bausteinen. Ein Baustein zeigt an, dass es eine neuere Version gibt.

Warum Betriebsanleitungen auseinanderlaufen: jede Maschine, eine Word-Kopie

Die Anleitung für die neue Maschine entsteht wie immer: Jemand kopiert die Word-Datei der letzten ähnlichen Maschine und ändert, was anders ist. Das geht schnell, und es funktioniert. Bis sich etwas ändert, das in allen Anleitungen steht.

Derselbe Sicherheitshinweis steht dann in Dutzenden Dateien. Eine Korrektur müsste in jeder einzelnen nachgezogen werden. In der Praxis passiert das bei den Anleitungen, an die gerade jemand denkt. Die englische Fassung hat den alten Wortlaut, die französische einen noch älteren.

Dazu kommen Fragen, die niemand gern hört. Welcher Stand gehört zu der Maschine, die vor Jahren ausgeliefert wurde? Wer hat ihn freigegeben? Welches Foto vom Schaltschrank auf dem Laufwerk ist das aktuelle? Das ist kein Versäumnis Ihrer Redaktion. Word kennt Dateien, keine Bausteine.

Das Ergebnis

Was sich in Ihrer Redaktion ändert

Vier Situationen aus der Technischen Redaktion, und was myDoku daran ändert.

Heute

Eine Korrektur, dutzende Dateien und trotzdem fehlerhafte Dokumentationen

Der zulässige Druck im Sicherheitshinweis war falsch angegeben. Jetzt sucht jemand alle Anleitungen heraus, in denen der Absatz steht.

Mit THDS

Sie korrigieren den Baustein einmal

Standardtexte liegen als Bausteine in einer Bibliothek. Geben Sie eine kleine Korrektur frei, werden die Betriebsanleitungen, die den Baustein verwenden, auf den neuen Stand gehoben. Vorher sehen Sie die Liste: welche aktualisiert und welche übersprungen werden, weil gerade jemand daran arbeitet.

Inhaltliche Erweiterungen und große Sprünge werden bewusst nicht automatisch nachgezogen. Die betroffenen Dokumente sind in der Liste markiert, und Sie entscheiden einzeln.

Vor der Freigabe steht fest, welche Betriebsanleitungen die Korrektur bekommen und welche nicht.

Heute

Neue Variante, neue Abtipperei

Die Maschine ist fast dieselbe wie die letzte. Trotzdem geht jemand die kopierte Datei Seite für Seite durch und ersetzt Maschinenbezeichnung und Seriennummer von Hand.

Mit THDS

Projekt duplizieren, Platzhalter setzen

Sie duplizieren das Projekt samt Betriebsanleitung, das Original bleibt unverändert. Maschinenbezeichnung, Seriennummer und weitere Angaben stehen als Platzhalter im Text und werden je Projekt einmal gesetzt. Was anders ist, ziehen Sie als Baustein aus der Bibliothek an die passende Stelle.

Heute

Die Übersetzung hinkt hinterher

Die deutsche Fassung ist korrigiert. Ob die englische und die französische nachgezogen wurden, weiß nur, wer die Dateien nebeneinanderlegt.

Mit THDS

Sie sehen, welche Sprache noch fehlt

Jeder Stand einer Betriebsanleitung enthält alle ihre Sprachen. Beim Speichern warnt das System, wenn eine Sprache noch nicht angepasst wurde. Eine neue Sprachfassung übernimmt den Aufbau der Betriebsanleitung, fehlende Texte sind markiert. Checklisten-Bausteine lassen sich nach „Sprache fehlt“ filtern.

Heute

Welcher Stand gehört zu welcher Maschine?

Der Dateiname „Betriebsanleitung_final_neu“ verrät es nicht. Wer was geändert und wer es freigegeben hat, steht allenfalls in einer E-Mail.

Mit THDS

Jede Freigabe hat eine Nummer und eine Notiz

Entwurf und Freigabe sind getrennt. Jede Freigabe bekommt eine Versionsnummer und eine Notiz, was sich geändert hat. Ältere Stände bleiben lesbar, aber nicht mehr änderbar. Im Projekt sehen Sie die Maschine und den aktuellen Stand ihrer Betriebsanleitung auf einen Blick. An einer Betriebsanleitung arbeitet immer nur eine Person, und alle anderen sehen, wer.

Was noch dazugehört

Von der Dokumentation bis an die Maschine

Eine Betriebsanleitung endet nicht beim PDF.

Checklisten und Karten für die Maschine

Checklisten für Bediener, Reinigung und Wartung entstehen ebenfalls aus Bausteinen: mit Intervall, Zeitfenster und Gültigkeit. Wartungs-, Reinigungs- und Verschleißkarten hängen am Projekt, jeweils in einer freigegebenen Version. Auf Wunsch binden wir eine App an der Maschine an. Dann kommen freigegebene Checklisten bis zum Bediener.

QR-Codes an der Baugruppe

Für jede Baugruppe erzeugen Sie einen QR-Code, der direkt in das passende Kapitel führt. Der Code klebt an der Maschine, am Schaltschrank oder an der Zuführung. Bediener und Instandhaltung scannen ihn und sind im richtigen Kapitel, ohne in der Betriebsanleitung zu suchen. Wird ein Kapitel umbenannt oder entfernt, zeigt myDoku vor dem Export, welche Codes nicht mehr passen.

Bilder und Videos einmal gepflegt

Eine Medienbibliothek statt Laufwerksordner. Jedes Bild bekommt beim Hochladen eine Bildbeschreibung, dazu Kapitel, Benennung und bei Bedarf die Maschinennummer. Als veraltet markierte Bilder stehen nicht mehr in der normalen Auswahl.

Dahinter steckt

So funktioniert es: vom Baustein zur freigegebenen Betriebsanleitung

myDoku läuft im Browser. Jede Freigabe ist entweder eine kleine Korrektur, eine inhaltliche Erweiterung oder ein großer Sprung.

  1. 1

    Bausteine anlegen und freigeben

    Texte, die in vielen Anleitungen stehen, werden zu Bausteinen. Jeder wird Kategorien zugeordnet: Kapitel, Funktion, Maschinentyp und Baugruppe. So findet man ihn später wieder. Ohne diese Angaben gibt es keine Freigabe.

  2. 2

    Betriebsanleitung zusammenstellen, Platzhalter setzen

    Sie ziehen die Bausteine in die gewünschte Reihenfolge und ergänzen, was nur für diese Maschine gilt. Die Vorschau zeigt den Text mit den Werten des Projekts.

  3. 3

    Freigeben, ausgeben, an die Maschine bringen

    Ist der Stand fertig, geben Sie ihn frei. Heraus kommt, was Sie brauchen: das PDF, eine Textdatei, die QR-Codes. Oder ein Link auf die Online-Ansicht der Betriebsanleitung: Sie ist jederzeit abrufbar und zeigt immer den aktuellen Stand. Wer den Link hat, hat die aktuelle Fassung, ohne dass jemand ein neues PDF verschicken muss.

  4. 4

    Ändern: ein Baustein, eine Freigabe

    Ändert sich ein Standardtext, ändern Sie den Baustein und nicht die Betriebsanleitungen. Nach der Freigabe sind alle betroffenen Betriebsanleitungen aktualisiert oder zur Prüfung markiert.

Passen wir zusammen?

Für wen es passt. Und für wen nicht.

Es passt, wenn sich vieles wiederholt

Sie bauen Maschinen in Varianten, und ein großer Teil jeder Anleitung ist gleich. Sie liefern in mehreren Sprachen. Sie wollen sagen können, welcher Stand freigegeben ist. Wartung und Reinigung sollen nicht nur im PDF stehen, sondern an der Maschine ankommen.

Es passt nicht, wenn Word reicht

Sie schreiben eine Handvoll Anleitungen im Jahr, ohne Varianten und ohne Übersetzungen. Dann ist Word mit einer guten Vorlage das richtige Werkzeug, und das sagen wir Ihnen auch. Dasselbe gilt, wenn Sie ein System erwarten, das Texte selbst schreibt, übersetzt oder auf Normen prüft. Das macht myDoku nicht.

Einführung mit THDS

Wir richten es mit Ihrer Redaktion ein

myDoku ist kein Paket, das Sie allein befüllen müssen. Wir richten es mit Ihnen ein und passen es an Ihre Maschinentypen, Ihre Baugruppen und Ihre Kapitelstruktur an. Bestehende Texte übernehmen wir gemeinsam mit Ihnen in einem Workshop, angefangen bei denen, die in den meisten Anleitungen stehen.

Wir kommen aus dem Maschinenbau. Was eine Betriebsanleitung leisten muss und warum die Seriennummer auf dem Deckblatt stimmen sollte, verstehen wir deshalb. Wie Ihre Redaktion arbeitet, lassen wir uns trotzdem von Ihnen zeigen.

Ob sich das für Ihren Betrieb lohnt, klären wir vorher, zum Beispiel in der Potentialanalyse.

Ablauf der Potentialanalyse ansehen

Häufige Fragen

Was Sie zur Software für Betriebsanleitungen wissen wollen

Wir schreiben in Word. Müssen wir alles neu erfassen?

Nein, jedenfalls nicht auf einmal. Sinnvoll ist, mit den Texten anzufangen, die in fast jeder Anleitung stehen: Sicherheitshinweise, Transport, Reinigung, Wartung. Daraus werden die ersten Bausteine, und die nächste Betriebsanleitung entsteht bereits aus der Bibliothek.

Ältere Anleitungen bleiben, wie sie sind, bis sie ohnehin angefasst werden. Die Übernahme machen wir gemeinsam in einem Workshop: Wir gehen Ihre Anleitungen mit Ihrer Redaktion durch, legen fest, was ein Baustein wird, und bringen die ersten Texte ins System.

Ersetzt das ein Redaktionssystem (CCMS)?

Es deckt den Kern ab, für den Maschinenbauer ein Redaktionssystem anschaffen: Bausteine statt Kopien, Versionen mit Freigabe, mehrere Sprachen, Varianten über Platzhalter, Ausgabe als PDF. Dazu kommen Checklisten und Wartungskarten, die bis an die Maschine reichen.

Was ist mit Normen und Pflichtinhalten der Betriebsanleitung?

Das System prüft nicht, ob eine Anleitung einer Norm entspricht. Was hineingehört und wie es formuliert sein muss, entscheiden weiterhin Ihre Redaktion und die Fachleute, die Sie dafür heute schon hinzuziehen.

Was das System leistet: Ein einmal geprüfter Text steht in jeder Betriebsanleitung gleich, und eine Korrektur bleibt nicht in einzelnen Dateien hängen. Eine rechtliche Bewertung ist das nicht, und wir geben auch keine ab.

Wo liegen unsere Daten?

Wo Sie wollen. Entweder betreiben wir myDoku für Sie in einem deutschen Rechenzentrum, oder es läuft auf Ihren eigenen Servern bei Ihnen im Haus. Was für Sie passt, klären wir mit Ihrer IT, bevor der erste Text ins System kommt.

Was kostet das?

myDoku ist ein fertiges Produkt, es wird nicht für Sie neu entwickelt. Der Preis hängt vor allem davon ab, ob wir myDoku für Sie betreiben oder es bei Ihnen im Haus läuft. Dazu kommt einmalig der Workshop, in dem wir Ihre ersten Texte übernehmen. Eine konkrete Zahl nennen wir Ihnen im Erstgespräch.

Rechnen Sie ruhig dagegen, was Sie heute eine Korrektur kostet, die jemand in Dutzenden Dateien und in drei Sprachen nachziehen muss.

Passt dazu

Ihre Betriebsanleitungen laufen auseinander?

Erzählen Sie uns, wo es hakt. Wir sagen Ihnen ehrlich, ob sich Software an dieser Stelle rechnet und ob wir dafür die Richtigen sind.

Erstgespräch +49 2362 974097-2
Anrufen Erstgespräch