Redaktionssystem kontra FM12? - Wann macht ein Redaktionssystem unter wirtschaftlichen Bedingungen Sinn?
←
→
Transkription von Seiteninhalten
Wenn Ihr Browser die Seite nicht korrekt rendert, bitte, lesen Sie den Inhalt der Seite unten
Redaktionssystem kontra FM12?
Wann macht ein Redaktionssystem unter
w irtschaftlichen Bedingungen Sinn?
Ute Mitschke
tekom RG München, 22.05.2014
©Ute Mitschke, 05/2014
Wer spricht?
Dipl.-Ing. Ute Mitschke
▶ 1982: Programmierung in Assembler für den ersten Z8080
▶ 1992 - 1993: Dozentin in der Erwachsenen-Weiterbildung
▶ 1996 - 1998: DASA: Applikationsentwicklung FrameMaker + SGML
mit Prozess- und Datenanalyse
▶ 1998: DIN: Unterstützung bei der Einführung von Acrobat in
allen europäischen Normungsinstituten
▶ 1999: Stiftung Warentest: Erstellung Pflichtenheft, Marktrecherche und
Beratung von bei der Auswahl eines XML-basierten CMS
▶ 1999: Addison Wesley, „Technische Dokumentation mit FrameMaker 5.5”
▶ 2002: Addison Wesley, „FrameMaker 6+7 – Praxisbuch”
▶ 2003: Konzeption und Entwicklung von Katalog-Produktionen mit FM+XML
▶ seit 2004: Trainerin für Acrobat, PDFmark, FrameMaker, FM+MIF, FM+XML …
▶ 2009 - 2010: Schaerer AG: Konzept und Umsetzung von Content-Management
ohne CMS mit FrameMaker+XML (Schweiz)
▶ seit 2012: HS Karlsruhe: Dozentin im Kompaktstudium Techn. Dokumentation
▶ seit 2013: Adobe Partner, Freier Schema Partner
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 2Inhalt:
▶ Warum Modularisieren? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
► Wege zur Realisierung. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
► Sofortige Einführung eines Redaktionssystems. . . . . . . . . . . . . . . . . . . . . . . . 6
▶ Modularisierung ohne Redaktionssystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
▶ Modularisierung skalierbar umsetzen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
▶ Modulkonzept entwickeln . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
▶ Modulkonzept verfeinern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
▶ Konkretes Vorgehen in der Praxis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
▶ Die Prozesse im Überblick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
► Strukturierung der Informationen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
► Konzeption von Metadaten . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
► Erstellung von passenden Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
► Verwalten aller Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
► Zusammenfügen der Module zu Kapiteln . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
► Publikation eines Handbuchs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
► Archivierung freigegebenen Handbücher . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
► Übersetzung eines Handbuchs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
▶ Konvertierung der Module nach XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
▶ Arbeiten mit strukturierten FM-Dokumenten . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
▶ Export nach XML, Auswahl/Import in ein CMS . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
▶ Demonstration anhand eines Beispiels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 3Warum Modularisieren?
▶ Übersetzungskosten sparen?
▶ Effizienter und Konsistenter arbeiten?
▶ Inhalte vereinheitlichen?
▶ Nur zutreffende Information publizieren?
▶ Varianten managen
▶ Inhalte in verschiedenen Dokument-Typen
wiederverwenden?
▶ Einfachere Verwaltung der Inhalte?
▶ Eindeutige Übersicht über den Stand der Inhalte?
▶ Layout-unabhängig arbeiten?
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 4Wege zur Realisierung
Modularisierung Ihrer Informationen gibt es
nicht von der Stange!
Sie ist so individuell wie Ihre Produkte
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 5Sofortige Einführung eines Redaktionssystems
▶ Was geschieht, wenn die Konzepte zur Modulgröße und
-fragmentierung nicht für alle Publikationen passen?
▶ Was, wenn sich die Struktur-Definition als nicht
passend erweist?
▶ Welche Konsequenzen werden erwartet, wenn
zusätzliche Metadaten nachträglich benötigt werden?
▶ Wie kann man vorgehen, wenn sich die Ablagestruktur
der Informationen/Module nach einer Weile Arbeitens
als ungeeignet erweist?
▶ Nachher ist man immer schlauer...?
▶ Der Trend geht zum Zweit- oder Dritt-System?
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 6Modularisierung ohne Redaktionssystem
▶ Was, wenn die Modulablage nicht mehr handhabbar
ist?
▶ Wie kann man damit umgehen, wenn mehrere
Versionen eines Moduls einsetzen möchte?
▶ Wie können Übersetzungen effizient gehandhabt
werden?
▶ Lässt sich ein Moment-aktueller Verwendungsnachweis
erstellen?
▶ Wie funktionieren Querverweise?
▶ usw. …
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 7Modularisierung skalierbar umsetzen
▶ Die ersten Schritte in der Modularisierung ohne
Redaktionssystem und ohne XML.
▶ Schrittweise Verfeinerung des
Modularisierungskonzepts.
▶ Konsistente Terminologie einbringen.
▶ Wissen, was wo welchen Stand hat.
▶ Einführung von XML als Struktur-Basis?
▶ Einführung eines Redaktionssystems mit der
Erfahrung, was wie womit am effektivsten geht?
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 8Modulkonzept entwickeln
Ausgangspunkt: Produkt-Palette
▶ Definition von Modulen orientiert am Produkt erfordert
Analyse der Produktstruktur
▶ Identifikation aller Detail-Unterschiede anhand der
Produkt-Palette
▶ Zuordnung zu Produktgruppen und –klassen,
Anlagenkomponenten, Optionen usw.
▶ Identifikation der Varianten-Management-Methode
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 9Modulkonzept verfeinern
Differenzierung:
▶ nach Zielgruppe
▶ nach Publikationsart
(z.B. Betriebs-/Service-Anleitung, Dialoge der
Anlagensteuerung, Produktdatenblätter)
▶ nach Publikationsinhalten
(Handlungsanweisung, Wartungintervalle, Stücklisten)
▶ nach Umfang der zu unterscheidenden Inhalte
(einzelne Werte/Wörter, Absätze, Kapitel)
▶ nach Ziel-Medium
(Webseite, Print-PDF, OnlineHilfe-CHM, App, Audio…)
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 10Konkretes Vorgehen in der Praxis
▶ Start mit konkreten Publikationen von
► einem Handbuchtyp - nur Betriebsanleitungen oder
nur Service-Anleitungen usw.
► einer Produktgruppe
▶ mehrere Anleitungen komplett ausdrucken
▶ Start mit dem Vergleich des Inhaltsverzeichnisses
Notieren der Unterschiede in den Kapiteln
▶ usw.
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 11Die Prozesse im Überblick
▶ Strukturierung der Informationen in FrameMaker-
Dokumenten
▶ Konzeption einer Ablagestruktur
▶ Konzeption einer Benennung der Modul-Dateinamen
▶ Konzeption von Metadaten
▶ Verwalten aller Module
▶ Zusammenfügen der Module zu Kapiteln für eine
konkrete Ausgabe
▶ Archivieren freigegebener Handbücher
▶ Übersetzen von Modul-Inhalten
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 12Strukturierung der Informationen
▶ Die Strukturierung der Informationen in FrameMaker-
Dokumenten kann realisiert werden:
► durch Format-Namen, die sich am Inhalt der
Information orientieren
► oder durch eine XML-Struktur-Definition.
▶ Die Strukturierung der Inhalte ermöglicht es, einerseits
die Formatierung leicht und gezielt anzupassen und
weiterhin spezielle Inhalte aus den Modulen zu
extrahieren und in anderer Form zu publizieren.
▶ Außerdem können inhaltlich differenziert formatierte
Module mithilfe von Konvertierungstabellen nach XML
überführt werden.
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 13Konzeption von Metadaten
▶ Beschreibung des Inhalts, um auch bei kleinen
Fragmenten den Inhalt eindeutig zuordnen zu können
▶ Angabe des Status der Bearbeitung, z.B.
► In Bearbeitung
► redaktionell geprüft
► fachlich geprüft
► freigegeben
► veraltet
▶ Kennzeichnung des Ursprung des Moduls
▶ Angabe einer Versionsnummer für das Modul.
▶ ... weitere entsprechend den Prozessanforderungen
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 14Erstellung von passenden Templates
▶ Modul-Template
► neutral ohne Seitenlayout der Publikation
► ohne fortlaufende Kapitel-Nummerierung
► Produktbezug nur in Metadaten oder in
benutzerdefinierten Variablen
▶ Publikations-Template
► definiert das Layout der Ausgabe
► Unterschiedliches Layout ist möglich
► Enthält die konkreten Angaben zum Projekt,
Handbuch, Produkt, Sprache, Version usw.
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 15Verwalten aller Module
▶ Arbeiten in der Modul-Ablage
▶ Bei der Modularisierung entstehen
► viele FrameMaker-Dokument-Module
► tief verschachtelt in der Ablagestruktur
▶ FrameMaker-Buch zum Verwalten der Module
► Module können direkt aus dem Verwaltungsbuch
geöffnet werden
► in allen Modulen können so leicht Formate
ergänzend importiert werden
► Informationen über den aktuellen
Bearbeitungszustand aller Module in einem
Verzeichnis übersichtlich generiert werden
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 16Zusammenfügen der Module zu Kapiteln
▶ Arbeiten in der Publikations-Ablage
▶ Erstellen eines Master-Handbuchs für jeden
Handbuchtyp
► Pro Kapitel ein leeres Kapitel-Dokument
▸ in jedem Kapitel-Dokument werden alle Module in
allen Varianten in der passenden Reihenfolge als
Texteinschub referenziert.
▶ Zusammenstellen von Stücklisten und Listen mit
Modul-Dateinamen und Definition einer Reihenfolge
► NUR Script-basiertes Zusammenstellen von
speziellen Ausgaben für konkrete Produkte.
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 17Publikation eines Handbuchs
▶ Arbeiten in der Publikations-Ablage
▶ Master-Handbuch mit allen Kapitel-Dateien kopieren
▶ Kapitel öffnen und alle nicht zutreffenden Varianten
löschen (Script-basiert oder manuell)
▶ Gegebenenfalls Formate aus einem speziellen Kapitel-
Template importieren
▶ Publikation überprüfen und freigeben
▶ Texteinschübe auflösen und Querverweise anpassen
▶ Inhaltsverzeichnis erzeugen
▶ Inhalte aktualisieren und ausgeben
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 18Archivierung freigegebenen Handbücher
▶ Kopie eines Handbuchs und aller enthaltenen Kapitel
erstellen.
▶ In den Kapiteln die referenzierten Texteinschübe in Text
umwandeln.
▶ In den Kapiteln alle referenzierten Abbildungen als
Kopie einfügen.
▶ Alle Verwaltungs-Aufgaben können manuell oder
Script-basiert umgesetzt werden.
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 19Übersetzung eines Handbuchs
▶ Voraussetzung ist ein entsprechender Aufbau der
Modulablage
▶ Moduldateinamen müssen in allen Sprachversionen
den selben Dateinamen haben, um die Kapitel-
Dokumente der Quell-Sprachen-Ausgabe für alle
Sprachen wiederverwenden zu können
▶ Aufgaben an den Übersetzungsprozess
► Identifizieren der Module zur Übersetzung
► Erstellen einer Voransicht für den Übersetzer
► Export der Module aus der Ablagestruktur
► Import der Module in die Zielsprachen-Ablage
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 20Konvertierung der Module nach XML
▶ Aufbau einer XML-Applikation in FrameMaker
► XML-Applikation implementiert eine spezifische
XML-Struktur-Definition (DTD) in FM-Dokumente.
► Sorgt für die richtige Umsetzung beim Im- und
Export von XML zu formatierten, strukturierten
FrameMaker-Dokument-Inhalten.
▶ Konvertierungstabelle
► Definiert Regeln, welche Formate welchen
Elementen zugeordnet werden.
► Ermöglicht das Verschachteln der Elemente in eine
hierarchische Struktur
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 21Arbeiten mit strukturierten FM-Dokumenten
▶ Definiert die Hierarchie, Reihenfolge und Nutzung
konkreter Elemente in den Dokumenten
► zum Beispiel:
▶ Unterstützung durch die Funktionen von FrameMaker
als XML-Editor:
► konkrete Anzeige verschiedener Validitätsfehler
► Einfügen von Elementen inklusive Kind-Elementen
► Smart-Paste aus HTML/Word/EXCEL-Dateien
► XPath 2.0 und XSLT 2.0 direkt anwenden
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 22Export nach XML, Auswahl/Import in ein CMS
▶ XML-Applikation in FrameMaker ermöglicht den Export
nach XML, nicht nur für Übersetzungsprozess.
▶ Entsprechend der erwarteten Funktionalität kann ein
passendes Redaktionssystem ausgewählt werden.
▶ Entscheiden, ob die eigene Struktur an die
Standard-Struktur eines CMS angepasst wird
oder ob das CMS auf die eigene Struktur angepasst
wird.
▶ Bei Bedarf die Modul-Inhalte beim Export nach XML
durch XSLT an die Zielstruktur anpassen.
▶ Import der Module in das CMS
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 23Demonstration anhand eines Beispiels
weiter geht es in
den Beispielen
▶ Arbeiten mit FrameMaker
Version 7 bis 10
ist manuell möglich
▶ Script-Unterstützung ab
FrameMaker 10
▶ Viele weitere Vorteile mit
FrameMaker 12
Diskutieren Sie mit uns im Forum unter
http://ute-mitschke.de/forum/foren.html
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 24Vielen Dank für Ihre Aufmerksamkeit!
Publikationstechnologien Ute Mitschke
Dipl.-Ing. (TU)
Consulting & Training Münchener Straße 35a
Konzeption & Umsetzung 82362 Weilheim
Informations-Design Tel.: +49 881 1 22 33 116
XML, FrameMaker, Acrobat Mobil: +49 172 316 13 73
TR/TD, CMS, Kataloge eMail: info@ute-mitschke.de
Adobe Partner www.ute-mitschke.de
tekom RG München, 22.05.2014 | Redaktionssystem kontra FM12? 25Sie können auch lesen
