Dokumentation: Redaktion, Übersetzung und Publikation.

Ja. Zunächst werden die benötigten Dateien identifiziert: Referenzversion, Anhänge, Originalbilder, Tabellen und verfügbare Übersetzungen. Formatvorlagen, Überschriftenebenen, Bildlegenden und Verweise werden untersucht. Offene Korrekturen und Kommentare werden berücksichtigt.

Die Überarbeitung kann mit harmonisierten Vorlagen und Stilen in Word bleiben oder einen Wechsel zu einem anderen Publikationsablauf vorbereiten. Die Wahl hängt von Aktualisierungen, Varianten und der Zahl der beteiligten Personen ab.

Eine repräsentative Stichprobe prüft Tabellen, Abbildungen und besondere Elemente vor der Gesamtverarbeitung. Ein Import garantiert allein weder Qualität noch Konsistenz des erhaltenen Dokuments.

Dokumente werden verglichen, um Wiederholungen, Widersprüche und unterschiedliche Begriffe zu erkennen. Ein gemeinsamer Aufbau und Schreibregeln werden festgelegt: Komponentenbezeichnungen, Einheiten, Anweisungen, Schritte und Detailgrad.

Zu lange oder mehrdeutige Formulierungen werden überarbeitet. Veraltete Angaben werden nach Freigabe entfernt, fehlende Informationen benannt. Derselbe Begriff kann so eine Komponente im Handbuch, in der Oberfläche und in Schulungsunterlagen bezeichnen.

Inhaltliche Änderungen bleiben von Darstellungskorrekturen getrennt. Ein flüssigerer Text muss Fakten, Werte und Einsatzbedingungen des Produkts erhalten.

Inhalte werden nach ihrer Funktion organisiert: Verfahren, Erklärung, technische Referenz oder Warnung. Diese Ordnung wird vom Layout getrennt. Eine Anweisung wird also nicht nur dadurch erkannt, dass sie fett erscheint.

Inhaltseinheiten können zur Wiederverwendung vorbereitet werden. Ein für mehrere Modelle gemeinsames Verfahren wird beispielsweise an einer Stelle gepflegt und in die betroffenen Publikationen integriert. Varianten bleiben ausdrücklich gekennzeichnet, damit keine falsche Anweisung an die falsche Zielgruppe gelangt.

Die Methode kann mit konsistenten Stilen und einer klaren Gliederung beginnen. Sie erfordert nicht sofort eine vollständige XML-Migration.

DITA ist eine XML-Architektur für wiederverwendbare Themen, insbesondere Verfahren, Konzepte und Referenzen. Zusammenstellungen, sogenannte Maps, bilden verschiedene Publikationen aus diesen Inhalten. Sie ist prüfenswert, wenn mehrere Produkte oder Zielgruppen einen grossen Dokumentationsbestand teilen.

DocBook ist ein XML-Vokabular, das unter anderem für Hard- und Softwaredokumentation verwendet wird. Struktur und Transformationswerkzeuge unterstützen Publikationen sowie Web- und paginierte Ausgaben. Es kann zu einem bereits auf Büchern, Kapiteln oder Artikeln aufgebauten Ablauf passen.

Word und HTML können für andere Nutzungen geeignet sein. Die Auswahl beruht auf Dokumenten, erwarteter Wiederverwendung, Fähigkeiten der Schreibenden und vorhandenen Werkzeugen. Austauschformate mit Partnern und Übernahmebedingungen zählen ebenfalls.

Konvertierungen, besondere Elemente und gewünschte Ausgaben werden an einer Stichprobe erprobt. Der Formatname garantiert weder automatische Übernahme noch vollständige Kompatibilität mit jeder Software.

Eine Quellversion wird mit Referenzterminologie und unverändert zu belassenden Namen festgelegt. Gemeinsame Inhalte, Varianten und geänderte Stellen werden für die Sprachbearbeitung identifiziert.

Bestehende Übersetzungen können geprüft und wiederverwendet werden, soweit sie noch zum Inhalt passen. Je nach Projekt unterstützen Übersetzungswerkzeuge und KI die Produktion. Begriffe, Werte, Verweise und Anweisungen werden geprüft; eine plausible Übersetzung kann technisch falsch sein.

Sprachen, Freigabeverantwortliche und Prüftiefe werden vor dem Beginn vereinbart. Gelieferte Versionen bleiben mit ihrer Quelle verbunden.

Die Publikation kann vollständige Handbücher, gezielte Anleitungen, Online-Hilfe oder Wartungsanweisungen liefern. Gemeinsame Inhalte werden von produkt-, options- oder zielgruppenspezifischen Elementen getrennt.

Beispiel: Drei Varianten einer Anlage teilen Wartungsvorgänge, aber nicht die Einstellungen. Gemeinsame Inhalte werden zusammen gepflegt; Einstellungen werden den jeweiligen Varianten zugeordnet. Jede Ausgabe muss in ihrem Kontext geprüft werden.

Vorlagen, Verknüpfungen, Bilder, Tabellen und Seitenumbrüche werden in den gelieferten Formaten kontrolliert. Eine gemeinsame Quelle erleichtert Konsistenz, ersetzt aber nicht die Prüfung der Publikation.

Ein Handbuch für Web und Druck ansehen FR

Karbonics eigene Werkzeuge und wiederverwendbare Arbeitsanweisungen steuern Vorbereitung, Überarbeitung und Prüfungen. KI kann wiederkehrende Schritte beschleunigen; Produktinformationen und redaktionelle Entscheidungen werden weiterhin geprüft.

HTML Editor wird von Karbonic für strukturierte Redaktion und Publikation mit einem steuerbaren Arbeitsablauf entwickelt. Es lässt sich vollständig durch KI bedienen. Erforderliche Funktionen und Formate werden vor der Übernahme konkret geprüft.

HTML Editor kennenlernen

Das Angebot nennt Inhalte, Sprachen, Ausgabeformate, übergebene Quellen und erwartete Freigaben. Es trennt die anfängliche Bereinigung von der Produktion weiterer Versionen.

Die Seitenzahl erklärt nicht alles: Quellenzustand, fehlende Abbildungen, Unstimmigkeiten, Varianten und Sprachen beeinflussen den Aufwand. Ein erstes Paket zeigt das Ergebnis und präzisiert die weiteren Arbeitsschritte.

Ein oder zwei repräsentative Dokumente und die Liste gewünschter Publikationen reichen zum Einstieg. Originaldateien und verfügbare Bilder vermeiden unnötige Rekonstruktion.

OASIS: Themen und Wiederverwendung in DITA · DocBook: Dokumentation und Publikationswerkzeuge