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

Redaktionssysteme, Epilog: Anpacken – aber wo?

28.03.201312.11.2019

Eigentlich hatte ich schon beschlossen, es mit dem doch recht langen Traktat zu Redaktionssystemen in der Technischen Dokumentation bewenden zu lassen. Immerhin ist der Text sehr theorielastig, da es sich ja in erster Linie um Überlegungen und Gedankenspiele zur Einführung eines Redaktionssystems handelt. Und natürlich den möglichen Hürden, die es zu bewältigen gilt. Mit anderen Worten: bislang ging es um die Planungsphase. Im Anschluss daran folgt die Entscheidung: Ob überhaupt ein Redaktionssystem Sinn ergibt und wenn ja, welches. Diese Fragen lassen sich nicht pauschal beantworten, denn sie hängen von einer Vielzahl sehr unterschiedlicher Faktoren ab.

Dennoch kann auch die Redaktion selbst unabhängig davon Vorbereitungen treffen, die sogar dann Sinn machen, wenn denn noch keine Entscheidung für ein Redaktionssystem gefallen ist. Denn – und das kann man nicht oft genug wiederholen: Auch ein Redaktionssystem ist ein System und erfordert von allen Beteiligten eine systematisch Vorgehensweise. Das Denken können die Maschinen nicht übernehmen.

Die folgenden Tipps mögen zwar banal klingen, aber im redaktionellen Alltag und unter dem Druck des Alltags fallen so manche Handgriffe gern mal aus – und können bei der Einführung eines Systems dem Benutzer auf die Füße fallen. Die folgenden Schritte können natürlich deshalb auch angewendet werden, wenn man kein Redaktionssystem einsetzt. Das Redaktionssystem aber ist jedoch viel unerbittlicher als ein Mensch und straft „Großzügigkeiten“ mit teilweise erheblichem Mehraufwand.

Umdenken

Bereits aus den bislang angestellten Überlegungen zu Redaktionssystemen wird deutlich, dass eine systematische Vorgehensweise ein teilweise erhebliches Umdenken erfordert. Dies gilt erst recht für Redaktionssysteme, denn diese trennen unerbittlich den Inhalt von der Form. Wo vorher jeder Text, der beispielsweise mit „Standard+Arial+16pt+fett“ und „18 Punkt Zeilenabstand unten“ formatiert war, als Überschrift durchging – selbst wenn er nur 17 Punkt Zeilenabstand unten hatte, erkennt das System nur Überschriften, keine Schriftschnitte oder Zeilenschaltungen an. Formatangaben werden unerbittlich gelöscht. Das führt dazu, dass bei der Datenmigration (oder dem Überschreiben der Dokumentvorlage) das System unweigerlich eine Zuordnung trifft und die vorhandenen Formatangaben einem Element zuordnet. Alle Abweichungen, also beispielsweise ein geänderter Zeilenabstand, werden nicht als Überschrift anerkannt. Und der Redakteur verbringt zahllose Stunden damit, jeden Textbaustein nach diesen „Ausreißern“ zu durchsuchen.

Das muss aber nicht sein. Sie können dem Problem auch im Redaktionsalltag mit einfachen Mitteln begegnen:

  • Nutzen Sie die im Programm (Word, FrameMaker et al.) vorhandenen Möglichkeiten, die „irregulären“ Formate in reguläre Formate (also solche, die laut Vorlage zugewiesen sein sollten) zu überführen.
  • Löschen Sie alle Zeilenschaltungen ohne Inhalt (Leerzeilen) beispielsweise per Suchen und Ersetzen. Abstände zwischen Zeilen müssen grundsätzlich und immer über die Formatangaben gesteuert werden.
  • Passen Sie die verwendeten Bilder und Grafiken an. Die weit verbreitete Angewohnheit, ein Bild oder eine Grafik nachträglich im Textverarbeitungsprogramm noch mit Nummern und Pfeilen zu versehen, führt oft schon in „normalen“ Dokumenten zu Problemen. In einem Redaktionssystem geht das gar nicht. Alle Objekte in einer Darstellung müssen auch in der Darstellung abgelegt sein. Das bedeutet, dass hier ein Bildbearbeitungs- oder Illustrationsprogramm zum Einsatz kommen muss. Wie man das recht unkompliziert lösen kann, habe ich an anderer Stelle beschrieben.

Vorbauen

Auch ein Redaktionssystem verfügt über eine Art Ablagestruktur: Ordner für Textbausteine und Ordner für Bilder und Grafiken. Selbst wenn sich diese Ordner vielleicht nicht ganz so bedienen lassen, wie Sie es vom Ihrem Betriebssystem her gewohnt sind, so erfüllen sie doch einen ähnlichen Zweck: Sie schaffen Ordnung. Dies umso mehr, als sie auch einer einheitlichen Benennung bedürfen, um die Übersichtlichkeit und Konsistenz zu gewährleisten. Sie benötigen Ordner für Produktvarianten, für Kapitel, für produktunabhängige Textbausteine und für Vorlagen. Diese können dann wiederum Ordner enthalten, die das Produkt oder die Varianten besser klassifizieren.

  • Legen Sie eine Ablagestruktur fest, bevor Sie das Redaktionssystem zum ersten Mal starten. Beim Import der ersten Daten in das Redaktionssystem haben Sie bereits die Möglichkeit, den Ablageort der Textbausteine und Bilder anzugeben.
  • Geben Sie den Grafiken eindeutige Namen, damit sie wiedergefunden und zugeordnet werden können.

Das Redaktionssystem wird die Texte und Bilder in Ihrem importierten Dokument trennen und in die angelegten und zugewiesenen Ordner verschieben – nur um sie dann beim Öffnen des Textbausteins wieder zusammenzuführen. Sobald nämlich erst einmal 500 Textbausteine und 400 Bilder importiert sind, wird es zunehmend mühsamer, die Bestandteile der Textbausteine nachträglich korrekt zuzuordnen.

Das gilt übrigens auch für ein Ablagesystem auf Dateiebene.

Zusammennageln

Der dritte und schwierigste Teil – und der Teil, der später das meiste Kopfzerbrechen bereitet – ist die eigentliche Dokumentstruktur, die eigentliche inhaltliche Gliederung des Dokuments. Aus Sicht des Systems können Sie jeden Knoten an jede Stelle schieben und auch mehrfach verwenden. Sie können problemlos in Produktvariante 1 die Technischen Daten direkt nach dem Inhaltsverzeichnis anführen und in Variante 2 mitten im Kapitel zur Inbetriebnahme. Oder den selben Abschnitt mehrmals im Dokument unterbringen. Da sind der Kreativität da keine Grenzen gesetzt …

Hier ist der Technische Redakteur gefragt. Die Redaktion legt fest, welche Textbausteine in welcher Reihenfolge im fertigen Dokument erscheinen werden und wie sich diese Textbausteine aufeinander inhaltlich beziehen. Oft werden nämlich schon  bei der Betrachtung des Status Quo die Lücken und Inkonsistenzen in der Dokumentation deutlich, die Sie durch das Redaktionssystem mitunter wesentlich leichter stopfen können – sofern Sie denn diese identifiziert haben.

  • Stellen Sie sich dazu einen „Strukturbaum“, eine inhaltliche Gliederung zusammen, anhand der Sie das fertige Dokument später wieder „zusammennageln“ können. Wie man das macht, können Sie hier nachlesen. Für diese „Karte“ (Fachlaute werden eine Ähnlichkeit zu einer DITA-Map erkennen) können Sie jede Textverarbeitung oder jedes Gliederungs-Programm benutzen.
  • Legen Sie für jedes Produkt eine Gliederung an und vermerken Sie für jeden Abschnitt den Bearbeitungsszustand bzw. die zu bearbeitenden Dokumentbausteine (Grafik, Tabelle, Text etc.). Das hilft, die wichtigsten Löcher zuerst zu stopfen und erleichtert es den Kollegen, Ihnen gegebenenfalls unter die Arme zu greifen.
  • Testen Sie Ihre Überlegungen an der Dokumentation eines Produkts, das nicht häufig nachgefragt wird.
  • Verfeinern Sie schrittweise die Struktur und den Inhalt. Dokumentation ist nie fertig.

Fazit

Eigentlich sollte der Umstieg auf ein Redaktionssystem einfach sein, wenn vorher bereits redaktionell systematisch gearbeitet wurde. Leider ist dies aus den unterschiedlichsten Gründen oft nicht der Fall. Natürlich können Sie sich dazu Hilfe holen durch externe Mitarbeiter. Aber auch diese müssen eingewiesen werden und benötigen Unterstützung bei der Einarbeitung in Ihre Systematik. Dieser Teil der Arbeit bleibt glücklicherweise immer an Ihnen hängen. Glücklicherweise, weil das großartigste Werkzeug der Technischen Redaktion dabei zum Einsatz kommt: das Gehirn.

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 RedaktionssystemstrukturSystem

Beitragsnavigation

Previous post
Next post

Related Posts

appseits

Dropbox Paper: Mal ohne Zettelwirtschaft

25.02.201703.11.2018

Und wieder mal zum Thema „papierloses Büro“: Wieso kämpfen Büros seit Jahren darum, von der Zettelwirtschaft wegzukommen, wenn sie sie über die Hintertür wieder einführen?…

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
dokumentation

Die Dropbox-Office: Let’s work together 2.0

27.04.201610.01.2022

„Cloud? Viiel zu gefährlich. Da kann ja jeder Geheimdienst mitlesen!” Wer so denkt, sollte jetzt ganz schnell den Computer abschalten und die Trommeln herausholen. Alle…

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
dokumentation

MadCap Central: Einsteigen bitte!

23.11.201603.11.2018

Es geht ein Riss durch die Technische Dokumentation: Applikationen auf der einen Seite, Systemlösungen auf der anderen.

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:

  • Kritzeln auf Tafeln, Teil 1: Office und Notizen
  • Buchbesprechung: „Die große Transformation“
  • Manchmal ist es einfach unglaublich …
  • Ich bin mal gespannt
  • Mitgedacht
  • Carpe diem
  • Silbentrennung anpassen in InDesign
  • Zielgruppen und die Leichtigkeit des Seins
  • Lebenserschwerend
  • Breitbandkosten grotesk

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

  • Kritzeln auf Tafeln, Teil 1: Office und Notizen
  • Buchbesprechung: „Die große Transformation“
  • Manchmal ist es einfach unglaublich …
  • Ich bin mal gespannt
  • Mitgedacht
  • Carpe diem
  • Silbentrennung anpassen in InDesign
  • Zielgruppen und die Leichtigkeit des Seins
  • Lebenserschwerend

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