Zum Inhalt springen

TwinWorks für technische Publikationen

Software für technische Redaktion, die Anleitungen freigabereif macht.

Mit Software für technische Redaktion schreibt ein Hersteller seine Anleitungen, prüft sie, gibt sie frei und veröffentlicht sie. TwinWorks erstellt den Entwurf aus Ihren vorhandenen Anleitungen und Konstruktionsinformationen, Ihre Experten klären die Lücken, und Sie veröffentlichen eine freigegebene Ausgabe mit dem Kontext, den Sie bei Produktänderungen brauchen.

01 / Umfang festlegen

Wissen, was fehlt, bevor es die Publikation aufhält.

Legen Sie die Dokumente und Abschnitte fest, die Ihr Produkt braucht, ausgehend von einer Vorlage, einer vorhandenen Anleitung oder einer KI-gestützten Gliederung. Verfolgen Sie die Abdeckung dieser Anforderungen und weisen Sie Autoren und Prüfer zu, damit offene Arbeit einen klaren Verantwortlichen hat.

Wartungshandbuch CP-200CP200-MM · Stand der frühen Planung
Gliederung der Publikation6 Abschnitte

Abschnitt 1.0 Inhalt vorhanden

Sicherheitshinweise

Was dieser Abschnitt braucht
Die Anforderungen an das Freischalten vor der Wartung dokumentieren.
Aktueller Inhalt
Die vorhandene Anleitung enthält den Abschnitt zu Freischalten und sicherem Zugang.
Zugewiesene Verantwortung
Alex Chen · Technischer Redakteur
Maya Laurent · Prüferin Mechanik

CP200-MM · Entwurf Rev. 03

Abschnitt 2.0 Inhalt vorhanden

Produktübersicht

Was dieser Abschnitt braucht
Die Pumpe, ihre Hauptbaugruppen und den Umfang der Publikation beschreiben.
Aktueller Inhalt
Eine Pumpenübersicht und eine beschriftete Baugruppenabbildung sind aus der vorhandenen Anleitung verfügbar.
Zugewiesene Verantwortung
Alex Chen · Technischer Redakteur
Maya Laurent · Prüferin Mechanik

CP200-MM · Entwurf Rev. 03

Abschnitt 3.0 Informationen fehlen

Installation

Was dieser Abschnitt braucht
Die freigegebenen Anforderungen an Fundament und Ausrichtung aufnehmen.
Aktueller Inhalt
Der Installationsabschnitt wartet auf die Fundamentzeichnung. Die Gliederung hat einen Platzhalter; noch wird kein Installationsinhalt gezählt.
Zugewiesene Verantwortung
Leo Martin · Mitwirkender Konstruktion
Maya Laurent · Prüferin Mechanik

CP200-MM · Entwurf Rev. 03

Abschnitt 4.2 Wartet auf Prüfung

Kupplungsprüfung

Was dieser Abschnitt braucht
Zugang zur Kupplung, die Prüfung und den Wiedereinbau der Schutzhaube beschreiben.
Aktueller Inhalt
Ein Textentwurf und Abbildung 4-2 sind vorhanden. Die Referenz der Ersatz-Schutzhaube muss Maya prüfen.
Zugewiesene Verantwortung
Alex Chen · Technischer Redakteur
Maya Laurent · Prüferin Mechanik

CP200-MM · Entwurf Rev. 03

Abschnitt 6.0 Inhalt vorhanden

Fehlerbehebung

Was dieser Abschnitt braucht
Beobachtete Symptome und die durch Serviceinformationen gestützten Prüfungen auflisten.
Aktueller Inhalt
Die Tabelle mit Symptomen und Ursachen wurde aus der vorhandenen Anleitung importiert.
Zugewiesene Verantwortung
Alex Chen · Technischer Redakteur
Leo Martin · Mitwirkender Konstruktion

CP200-MM · Entwurf Rev. 03

Abschnitt 7.1 Wartet auf Prüfung

Ersatzteile

Was dieser Abschnitt braucht
Die Ersatz-Schutzhaube anhand der aktuellen Zeichnung identifizieren.
Aktueller Inhalt
Die Teiletabelle ist entworfen. Der Werkstoff der Schutzhaube muss mit Zeichnung CP200-GD, Rev. C, abgeglichen werden.
Zugewiesene Verantwortung
Alex Chen · Technischer Redakteur
Leo Martin · Prüfer Ersatzteile

CP200-MM · Entwurf Rev. 03

CP-200-Publikation zur Veranschaulichung, frühe Phase: Wählen Sie einen Abschnitt, um Anforderung, Inhalt und Verantwortliche zu sehen.

02 / Ersten Entwurf vorbereiten

Geben Sie Ihren Experten einen Entwurf als Ausgangspunkt.

Nutzen Sie vorhandene PDF- oder Word-Anleitungen und Konstruktionsdateien wie Schaltpläne und Zeichnungen, um strukturierte Inhalte vorzubereiten. Die KI hilft, Abschnitte zu entwerfen, Tabellen zu ordnen und passende Abbildungen ins Dokument zu bringen. Ihr Team bearbeitet das Ergebnis mit den zugehörigen Referenzen griffbereit.

01 Quelle auswählen Beispiel
CP200-EL Stromlaufplan: Drehstrom-Motorabgang, hervorgehobener Trennschalter Q1, Schütz und Steuerstromkreis
CP200-EL · Rev. C · Blatt 1Konstruktionsquelle
CP200-GD mechanische Zeichnung: Vorder-, Seiten- und Draufsicht, Befestigungsdetail und eine Werkstoffliste mit der Edelstahl-Schutzhaube
CP200-GD · Rev. C · Detail 1Konstruktionsquelle
02 Entwurf bearbeiten Bearbeitbares Beispiel
TwinWorksTECHNISCHER SERVICEWARTUNGSHANDBUCHCP200-MM · REV 03 / ENTWURF

04 / Wartungsverfahren

4.2 Prüfung der Kupplung

Technische Strichzeichnung der CP-200-Pumpe mit der Schutzhaube und ihren Befestigungsteilen über der Kupplung angehoben
Abbildung 4-2. Abnehmen der Schutzhaube
Tabelle 4-1. Prüfreferenz
Pos.KomponentePrüfen
01KupplungsschutzZustand und Sitz
02KupplungSichtbare Schäden

↗ Quelle: CP200-EL, Rev. C, Blatt 1 · Q1

CP-200 / WartungREV 03 / ENTWURF · 18

Beginnen Sie mit den Informationen, die Sie haben. Ergänzen Sie Konstruktionskontext, sobald er verfügbar ist.

03 / Prüfungen abschließen

Prüfungen voranbringen, mit den Belegen im Blick.

Weisen Sie jedem Abschnitt den richtigen Prüfer zu. Halten Sie Kommentare am Inhalt, vergleichen Sie Revisionen und sehen Sie die Quellen hinter technischen Aussagen ein. Autoren können angeforderte Änderungen umsetzen, während die Freigebenden die Kontrolle über die freigegebene Revision behalten.

CP200-MM / §4.2 Prüfung der KupplungÄnderungen angefordert

Später im Beispiel: Installationsinformationen eingegangen, andere Abschnitte geprüft. §4.2 ist die letzte offene Prüfung.

TwinWorksTECHNISCHER SERVICEWARTUNGSHANDBUCHCP200-MM · REV 03 / PRÜFUNG

04 / Wartungsverfahren

4.2 Prüfung der Kupplung

Bevor Sie beginnen

Schalten Sie die Anlage frei und stellen Sie einen sicheren Zustand fest, bevor Sie auf die Kupplung zugreifen.

03

Prüfen Sie die Kupplung und die Edelstahl-Schutzhaube vor dem Wiedereinbau auf sichtbare Schäden.1

Technische Strichzeichnung der CP-200-Pumpe mit der Schutzhaube und ihren Befestigungsteilen über der Kupplung angehoben
Abbildung 4-2. Abnehmen der Schutzhaube
Tabelle 4-1. Prüfreferenz
Pos.KomponentePrüfen
01KupplungsschutzZustand und Sitz
02KupplungSichtbare Schäden

[1] CP200-GD · Rev. C · Detail 1
Erstellt von Alex Chen · Technischer Redakteur

CP-200 / WartungREV 03 · 18

Verknüpfte Konstruktionsquelle

Fertigungszeichnung der Schutzhaube

Rev. C
Quellzeichnung CP200-GD Revision C mit Ansichten der Schutzhaube und hervorgehobenem Edelstahl-Eintrag in der Stückliste
CP200-GD · Blatt 1 · Detail 1EC-017

Position 01 bestätigt den Werkstoff.Der Prüftext stammt aus CP200-MM, Rev. 02, S. 18.

Veröffentlicht Rev. 02 → Vorgeschlagen Rev. 03

TwinWorksTECHNISCHER SERVICEWARTUNGSHANDBUCHCP200-MM · REV 02

4.2 Prüfung der Kupplung

Technische Strichzeichnung der CP-200-Pumpe mit der Schutzhaube und ihren Befestigungsteilen über der Kupplung angehoben
Abbildung 4-2. Schutzhaube

Prüfen Sie die Kupplung und die gelbe Schutzhaube auf sichtbare Schäden. Bauen Sie die Schutzhaube nach der Prüfung wieder ein.

CP200-GD · Rev. B

CP-200 / WartungREV 02 · 18
TwinWorksTECHNISCHER SERVICEWARTUNGSHANDBUCHCP200-MM · REV 03

4.2 Prüfung der Kupplung

Technische Strichzeichnung der CP-200-Pumpe mit der Schutzhaube und ihren Befestigungsteilen über der Kupplung angehoben
Abbildung 4-2. Schutzhaube

Prüfen Sie die Kupplung und die Edelstahl-Schutzhaube vor dem Wiedereinbau auf sichtbare Schäden.

CP200-GD · Rev. C

CP-200 / WartungREV 03 · 18

Alex Chen · Werkstoff der Schutzhaube und Text aktualisiert. Übrige Inhalte unverändert.

EntwurfPrüfungFreigegebenVeröffentlicht

Rev. 02 bleibt veröffentlicht. Die Freigabe von Rev. 03 veröffentlicht sie nicht.

04 / Geprüfte Arbeit wiederverwenden

Nutzen Sie das Wissen, das Sie bereits geprüft haben.

Verwenden Sie veröffentlichte Verfahren, Referenzmaterial und Dokumentvorlagen in Ihrem gesamten Publikationsbestand wieder. Die Verbindungen bleiben sichtbar, damit Autoren sehen, woher Inhalte stammen und welche Dokumente von ihnen abhängen.

Das Verfahren im Web und als PDF ansehen

Ein Verfahren, zwei Publikationen

KupplungsprüfungPR-042 · Veröffentlicht Rev. 02

Schutzhaube abnehmen → Kupplung prüfen → Schutzhaube wieder anbringen

Quelle: CP200-MM, Rev. 02, §4.2
Schutzhaube: CP200-GD, Rev. B

TwinWorksTECHNISCHER SERVICEWARTUNGSHANDBUCHCP200-MM · REV 02

CP200-MM / Serviceverfahren

Wartungshandbuch

4.2 Prüfung der Kupplung

Technische Strichzeichnung der CP-200-Pumpe mit der Schutzhaube und ihren Befestigungsteilen über der Kupplung angehoben
Abbildung 4-2. Abnehmen der Schutzhaube
↗ PR-042 · Revision 02
  1. Die Schutzhaube abnehmen.
  2. Die Kupplung prüfen.
  3. Die Schutzhaube wieder anbringen.
CP-200 / WartungREV 02 · 18
TwinWorksTECHNISCHE SCHULUNGSCHULUNG FÜR TECHNIKERCP200-TR · REV 02

CP200-TR / Praktische Übungen

Technikerschulung

2.3 Prüfung der Kupplung

Technische Strichzeichnung der CP-200-Pumpe mit der Schutzhaube und ihren Befestigungsteilen über der Kupplung angehoben
Abbildung 2-3. Schutzhaube und Kupplung identifizieren
↗ PR-042 · Revision 02

Folgen Sie demselben geprüften Verfahren. Identifizieren Sie die Komponenten und erklären Sie die Prüfreihenfolge.

CP-200 / SchulungREV 02 · 09

05 / Produktänderungen steuern

Nicht jede Revision ist eine Neufassung.

Wenn sich ein referenziertes Bauteil, eine Quelldatei oder ein Verfahren ändert, sehen Sie den Wirkungsbereich dieser Änderung: jeden verbundenen Abschnitt, der Aufmerksamkeit braucht. Prüfen Sie jeden einzeln, vergleichen Sie die vorgeschlagenen Änderungen und leiten Sie jede Aktualisierung durch die Prüfung, bevor Sie die nächste Ausgabe freigeben.

Prüfung von Änderungsfolgen ansehen
TwinWorksKONSTRUKTIONÄNDERUNGSMITTEILUNGEC-017

CP-200 / Schutzhaube

Eine Änderung an der Quelle.
Ein sichtbarer Wirkungsbereich.

VORHER / REV BCP-200-Pumpe mit ihrer ursprünglichen gelben Schutzhaube
Gelbe Schutzhaube
NACHHER / REV CCP-200-Pumpe mit der neuen Edelstahl-Schutzhaube
Edelstahl-Schutzhaube
QuelleCP200-GD
RevisionB → C
ÄnderungWerkstoff und Abbildung der Schutzhaube

Werkstoffangabe geändert. Verbundene Publikationen müssen geprüft werden.

Verbundene Inhalte 3 Abschnitte · 2 Publikationen

Vorgeschlagene Aktualisierung · CP200-MM §4.2

Gelbe Schutzhaube Edelstahl-Schutzhaube

Text und Abbildung 4-2 aktualisieren. Maya prüft den Werkstoff anhand von Zeichnung Rev. C.

Textstelle prüfen und ihre Prüfung abschließen

Vorgeschlagene Aktualisierung · CP200-MM §7.1

Schutzhaube · gelb Schutzhaube · Edelstahl

Werkstoff in der Teiletabelle aktualisieren. Beispiel einer Prüfung: Leo, Ersatzteilspezialist, hat ihn anhand von Zeichnung Rev. C geprüft.

Teiletabelle geprüft

Separate Prüfung · CP200-TR §2.3

Verfahren PR-042 · Rev. 02 Neue Referenz der Schutzhaube prüfen

Nora, verantwortlich für die Schulung, muss das wiederverwendete Verfahren und die Abbildungen prüfen. Die Schulungspublikation bleibt auf Rev. 02.

Wartet auf Prüfung der Schulung
Nächste Ausgabe: CP200-MM, Rev. 03

§7.1 geprüft · §4.2 wartet auf Mayas Freigabe.

Sorgen wegen veralteter Inhalte? Dokumentations-Drift-Scan anfragen Kostenloses Starterkit holen

06 / Freigegebene Publikation bereitstellen

Veröffentlichen Sie für die Menschen, die die Informationen brauchen.

Geben Sie eine freigegebene Ausgabe als strukturiertes Web-Handbuch oder als PDF in Ihrem Markendesign frei. Verbinden Sie klare Navigation, technische Abbildungen und eingebettete Verfahren. Bereiten Sie übersetzte Ausgaben mit bearbeitbarem Text vor und wählen Sie öffentlichen oder auf die Organisation beschränkten Zugriff.

CP200-MM · Rev 02 · Publikationsbeispiel

Wartungshandbuch / CP-200

4.2 Prüfung der Kupplung

Eingebettetes Verfahren PR-042 · Rev 02

CP-200-Pumpe mit montierter Schutzhaube
Abbildung 4-2 · Schutzhaube montiert

Schritt 1 von 3

Schutzhaube abnehmen

Nehmen Sie bei freigeschalteter Anlage die Schutzhaube ab, um die Kupplung freizulegen.

Verfahren zur Veranschaulichung, keine Serviceanweisung für den Betrieb von Anlagen.

Veröffentlichtes Dokument

CP-200
Wartungshandbuch

Dokument
CP200-MM
Ausgabe
Rev 02
Sprache
Englisch
Format
A4 · PDF

Nummerierte Verfahren, technische Abbildungen und eine gelenkte Seitenreferenz.

Dieses Beispiel-PDF herunterladen

Einseitiger Auszug zur Veranschaulichung

TwinWorksTECHNISCHER SERVICEWARTUNGSHANDBUCHCP200-MM / Rev 02

CP-200 / 04 Wartungsverfahren

4.2 Prüfung der Kupplung

Bevor Sie beginnen

Schalten Sie die Anlage frei und stellen Sie einen sicheren Zustand fest, bevor Sie auf die Kupplung zugreifen.

Prüfen Sie die Kupplung und die gelbe Schutzhaube auf sichtbare Schäden. Bauen Sie die Schutzhaube nach der Prüfung wieder ein.

Technische Strichzeichnung der CP-200-Pumpe mit abgenommener Schutzhaube und Befestigungsteilen
Abbildung 4-2. Kupplung und abnehmbare Schutzhaube
  1. Schutzhaube abnehmenLegen Sie bei freigeschalteter Anlage die Kupplung frei.
  2. Kupplung prüfenPrüfen Sie Kupplung und Schutzhaube auf sichtbare Schäden.
  3. Schutzhaube wieder anbringenNach der Prüfung wieder anbringen und die Befunde dokumentieren.
Tabelle 4-1. Prüfreferenz
Pos.KomponentePrüfen
01KupplungsschutzZustand und Sitz
02KupplungSichtbare Schäden

Referenz: CP200-GD · Rev. B · Detail 1

Revisions- und Freigabesteuerung ansehen

07 / Übersetzte Ausgaben vorbereiten

Struktur, Abbildungen und Referenzen bleiben erhalten. Ihre Sprachprüfer erhalten einen Entwurf zum Verfeinern.

Assistent
DokumentCP200-MM · Rev 02

Französische Ausgabe vorbereiten.

Französischer Entwurf bereit. Abbildungen und Referenzen bleiben erhalten.

Französischen Entwurf prüfen

Beispiel zur Veranschaulichung

FR / Französische AusgabeSprachprüfung ausstehend
TwinWorksSERVICES TECHNIQUESMANUEL DE MAINTENANCECP200-MM · FR / BROUILLON

CP-200 / 04 Procédures de maintenance

4.2 Inspection de l’accouplement

Pompe CP-200 avec le carter retiré pour inspecter l’accouplement
Figure 4-2. Accouplement et carter amovible
Tableau 4-1. Points de contrôle
Rep.ComposantContrôle
01Carter de protectionÉtat et fixation
02AccouplementDommages visibles

Basé sur l’édition anglaise · Rev 02

CP-200 / WartungFR · BROUILLON · 18

Nachweis / Verlauf einsehen

Revisionsbelege, die Prüfer einsehen können.

Verfolgen Sie eine technische Aussage bis zu ihrer Quelle, sehen Sie, wer sie geändert hat, und sehen Sie die Prüfung hinter der freigegebenen Ausgabe ein. Die Publikation und ihr Verlauf bleiben verbunden.

CP200-MM / PublikationsverlaufRevisionsverlauf zur Veranschaulichung
TwinWorksTECHNISCHER SERVICEWARTUNGSHANDBUCHCP200-MM · REV 02

04 / Wartungsverfahren

4.2 Prüfung der Kupplung

Technische Strichzeichnung der CP-200-Pumpe mit der Schutzhaube und ihren Befestigungsteilen über der Kupplung angehoben
Abbildung 4-2. Abnehmen der Schutzhaube

Prüfen Sie die Kupplung und die gelbe Schutzhaube auf sichtbare Schäden. Bauen Sie die Schutzhaube nach der Prüfung wieder ein.

↗ Verknüpfte QuelleCP200-GD · Revision B · Detail 1
CP-200 / WartungREV 02 · 18

Der Verlauf hinter dieser Seite

Von der Quelle bis zur Freigabe.

  1. Quelle verknüpft

    CP200-GD, Rev. B · Baugruppe Schutzhaube
    Referenziert von §4.2 und §7.1.

  2. Erstellt von Alex Chen

    Prüftext und Abbildung 4-2.
    Technischer Redakteur.

  3. Freigegeben von Maya Laurent

    Werkstoffangabe und Prüftext geprüft.

  4. Revision 02 freigegeben

    Englisches Handbuch · Web und PDF.
    Veröffentlichungsentscheidung separat dokumentiert.

PDF der Revision 02 ansehen
TwinWorksTECHNISCHER SERVICEWARTUNGSHANDBUCHCP200-MM · REV 03

04 / Wartungsverfahren

4.2 Prüfung der Kupplung

Technische Strichzeichnung der CP-200-Pumpe mit der Schutzhaube und ihren Befestigungsteilen über der Kupplung angehoben
Abbildung 4-2. Abnehmen der Schutzhaube
03

Prüfen Sie die Kupplung und die Edelstahl-Schutzhaube vor dem Wiedereinbau auf sichtbare Schäden.

↗ Geänderte Referenz · EC-017CP200-GD · Revision C · Detail 1
CP-200 / WartungREV 03 · 18

Die nächste Ausgabe

Prüfung läuft.

  1. Geänderte Quelle erkannt

    CP200-GD, Rev. B → C.
    Edelstahl-Schutzhaube ersetzt gelbe Schutzhaube.

  2. Aktualisiert von Alex Chen

    Text und Quellenangabe in §4.2 überarbeitet.
    §7.1 geprüft von Leo Martin.

  3. Wartet auf Mayas Freigabe

    Kommentar: Werkstoff nennen und Zeichnungsrevision C angeben.

  4. Noch nicht veröffentlicht

    Revision 02 bleibt für Leser verfügbar.

Prüfung des Abschnitts öffnen

Wählen Sie eine Ausgabe, um ihre Quelle und ihren Prüfverlauf einzusehen. Revision 03 folgt den Freigabe- und Veröffentlichungsschritten in diesem Beispiel.

Einige praktische Fragen

Beginnen Sie mit dem,
was Sie haben.

Was ist Software für technische Publikationen?

In einer Software für technische Publikationen schreiben, prüfen, freigeben und veröffentlichen Teams die Anleitungen, die mit einem Produkt ausgeliefert werden: Betriebs-, Wartungs-, Reparatur- und Ersatzteildokumentation. TwinWorks entwirft diese Inhalte aus Ihren vorhandenen Anleitungen und Konstruktionsdaten, zeigt, was eine Produktänderung betrifft, und veröffentlicht freigegebene Revisionen im Web und als PDF, mit Export von S1000D-Datenmodulen.

Können wir mit vorhandenen Anleitungen beginnen?

Ja. Importieren Sie PDF- oder Word-Dokumente als bearbeitbare Entwürfe und nutzen Sie vorhandenes Quellmaterial für die Erstellung. Fügen Sie Konstruktionsdateien hinzu, wo sie nützlichen Produktkontext liefern.

Wie behält das Team die Kontrolle über KI-generierte Inhalte?

Die KI bereitet bearbeitbare Inhalte vor. Autoren und Prüfer können Quellen einsehen, Änderungen anfordern, Revisionen vergleichen und das Dokument vor der Veröffentlichung freigeben.

Was passiert, wenn sich Quellinformationen ändern?

TwinWorks kann geänderte Referenzen und betroffene Inhalte zur Prüfung markieren. Ihr Team entscheidet, was korrigiert werden muss und wann die überarbeitete Ausgabe veröffentlicht wird.

Kann TwinWorks S1000D-Datenmodule exportieren?

Ja. TwinWorks exportiert beschreibende und prozedurale S1000D-Datenmodule. Nennen Sie uns die S1000D-Issue und die Geschäftsregeln (BREX), mit denen Sie arbeiten, und wir bestätigen die Einrichtung mit Ihnen in einer Arbeitssitzung. Sehen Sie, wie aus bestehenden Anleitungen S1000D-Datenmodule werden.

Ihre nächste Publikation

Beginnen Sie mit einer Publikation, die Sie fertigstellen oder aktuell halten müssen.

Bringen Sie eine vorhandene Anleitung mit, die Publikation, die Sie liefern müssen, oder eine aktuelle Produktänderung. Sehen Sie, wie Ihr Team die Arbeit strukturieren, einen Entwurf vorbereiten, Prüfungen abschließen und die nächste Ausgabe freigeben kann.

Siehe auch: Software für Bedienungsanleitungen · kostenlose Vorlage für Bedienungsanleitungen.

Aktualisiert