Technische Dokumentation 1 Single Source Publishing 2 Single

Technische Dokumentation ____________________________________________________________________________________________________________________ 1. Single Source Publishing 2. Single Source Publishing mit XML basierten Redaktionssystemen Einführung Wichtige Komponenten Modularisierung Metadaten Formate 3. Das C 3 Redaktionssystem Komponenten Werkzeuge Verwaltung 4. Einbindung vorhandener Dokumente 5. Workflow RJ 11/2/2020 2/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 1. Single Source Publishing bezeichnet die Überführung unterschiedlich formatierter Inhalte in ein gemeinsames Format (Quellformat) und die Produktion dieser Inhalte aus dem Quellformat in unterschiedliche Medien RJ 11/2/2020 3/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 1. Single Source Publishing Beispiel: Quellformat RTF Vorteile: Nachteile: Gewohntes Textverarbeitungsprogramm kann weiter genutzt werden Hoher Speicherplatzbedarf RJ 11/2/2020 4/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen RJ 11/2/2020 5/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen XML ist eine Metasprache, die Datenstrukturierung nach selbst festgelegten Regeln ermöglicht Mit einem Regelwerk - der Dokument Typ Definition (DTD) - können Dokumentenstrukturen definiert werden, bevor die Dokumenteninhalte verfügbar sind Der Einsatz von XML ist besonders dort lohnend, wo Inhalte maschinell auffindbar, zugänglich und manipulierbar gemacht werden sollen Für weitere Verarbeitungsschritte können Standardwerkzeuge verwendet werden, die z. B. das Auslesen, Durchsuchen, Sortieren oder Konvertieren von XML - Dokumenten übernehmen können Grundlegender Mechanismus XML basierter Formate ist die Umwandlung der Quellinformation in anwendungsorientierte Formate wie z. B. HTML, PDF, Print oder auch Grafik RJ 11/2/2020 6/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Quellformat XML Vorteil: Nachteil: XML-Archivierung benötigt nur etwa 1/10 des Speicherplatzes einer RTF-Archivierung Verwendung eines ungewohnten XML-Editors (Schulungskosten) RJ 11/2/2020 7/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Vorteile der Datenspeicherung in XML: Trennung von Format und (redaktionellem) Inhalt Homogenisierung unterschiedlicher Eingangsformate einmaliges Einpflegen redaktioneller Inhalte für Print-, PDFund HTML-Exporte Modulare Textstruktur, d. h. schnelle Austauschbarkeit von Dokumentenabschnitten durch Modularisierung der redaktionellen Inhalte Konfiguration der modularen Textstruktur über Metadaten Maschinelle Verarbeitbarkeit vereinfachtes Übersetzungsmanagement Plattformunabhängigkeit flexibel erweiterbar RJ 11/2/2020 8/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Modularisierung ermöglicht die unabhängige Kombination von Textbausteinen (Modulen) miteinander gestaltet die Textbausteine so, dass sie für möglichst viele (Produkte) Dokumente verwendbar sind Module sollten keine indirekten Referenzen auf andere Dokumententeile enthalten (Bsp. „s. Kap. 1. 3. “) Modulanfang und Modulende sollten keinen Übergang zum vorangehenden oder nachfolgenden Textbaustein enthalten (Bsp. „wie vorher beschrieben“, „im folgenden erläutert“ Module oder Modulgruppen sollen kurz, knapp und präzise sein und möglichst auf eine Browserseite passen, so dass kein Scrollen erforderlich ist Die Art der Modularisierung hat Einfluss auf die Verwaltung der Module RJ 11/2/2020 9/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Modularisierung nach Formaten Inhaltscharakterisierung des Moduls muss im Modulnamen, im Header oder in den Metadaten codiert werden (Bsp. Bügeleisen_Deutschland_ mit. Dampf_220 V) Modulauswahl erfolgt über die Modulnamen RJ 11/2/2020 10/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Modularisierung nach funktionalen Aspekten Es werden funktionale Inhalte zusammengefasst, die möglichst unverändert in unterschiedliche Kontexte eingebettet werden können Die Modulauswahl erfolgt über die Metadaten RJ 11/2/2020 11/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Modularisierung nach Kapiteln Kapitel der vorhandenen Dokumentation werden in Module überführt Die Modulauswahl erfolgt über die Metadaten und den Modulnamen (Überschrift) RJ 11/2/2020 12/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Metadatendefinition Metadaten bilden die Grundlage der Dokumentenverwaltung Metadaten ermöglichen die Zuordnung von Inhaltsmodulen zu bestimmten Dokumenten (Bsp. Version, Projekt, Sprache) die interne Verwaltung der Module (Bsp. Autor, Freigabestatus) die technische Verwaltung der Module (Bsp. : Grafik- bzw. Textmodul, verwendeter Editor, Modul zur externen Bearbeitung „ausgecheckt“) Die notwendigen Metadaten spiegeln die Verwaltungsstruktur der Dokumentation wider und müssen daher gemeinsam mit dem Anwender definiert werden. RJ 11/2/2020 13/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Formaterstellung Formatierungen für die verschiedenen Ausgabeformate müssen speziell gemäss den Wünschen des Anwenders erstellt und evtl. an bestehende Designformate für die Dokumentation angepasst werden RJ 11/2/2020 14/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 2. Single Source Publishing mit XML basierten Redaktionssystemen Bedingungen für eine effiziente Datenspeicherung in XML: Die Modularisierung redaktioneller Inhalte sollte mit hoher Sorgfalt durchgeführt werden, um Inhaltsmodule möglichst vielseitig und häufig verwendbar zu halten Formate und Terminologie sollen konsistent und diszipliniert gepflegt werden, um Inhaltsmodule möglichst langfristig verwendbar zu halten Metadaten zur Dokumentenverwaltung sollen sorgfältig und vollständig eingepflegt werden RJ 11/2/2020 15/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem stellt Methoden bereit, um Inhalte nach XML zu formatieren erzeugt HTML, PDF und PS aus XML – Inhalten stellt Verwaltungswerkzeuge bereit, um ihre Dokumente zu erfassen und zu organisieren ihren Auftragsbestand zu verwalten die Kundendaten zu ihrer Dokumentation zu pflegen steht sowohl als Standalone-System als auch als Web. Applikation zur Verfügung RJ 11/2/2020 16/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem Komponenten Werkzeuge Datenbank Grafische Bedienoberfläche (GUI) RJ 11/2/2020 17/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem Werkzeuge Konverter Textverarbeitung Grafikbearbeitung PDF-Viewer RJ 11/2/2020 18/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem Datenbanken werden über die JDBC Schnittstelle angeschlossen Einsatz unterschiedlicher Datenbanken von Open. Source (My. SQL) bis hin zu Oracle RJ 11/2/2020 19/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem Komponenten der grafischen Bedienoberfläche Kundenverwaltung Auftragsverwaltung Dokumentenverwaltung Modulverwaltung RJ 11/2/2020 20/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem Kundenverwaltung RJ 11/2/2020 21/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem Auftragsverwaltung RJ 11/2/2020 22/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem Dokumentenverwaltung RJ 11/2/2020 23/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 3. Das C 3 Redaktionssystem Modulverwaltung RJ 11/2/2020 24/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 4. Einbindung vorhandener Dokumente Bestandsaufnahme Erstellung von Formatvorlagen Tools und Makros zum Vorformatieren der Dokumente Grafikbearbeitung für Bildschirm- und Druckdarstellung Parametrisierung von speziellen Konvertern zum Einspeisen in die Datenbank Überarbeitung bzw. Neufassung des Redaktionshandbuchs RJ 11/2/2020 25/28

Technische Dokumentation ____________________________________________________________________________________________________________________ 5. Workflow Definition von Formaten und Metadaten Systeminstallation des C 3 Redaktionssystems Schulung/Einführung Ihrer Mitarbeiter Ersterfassung der Dokumentation und Modularisierung der redaktionellen Inhalte weitere Dienstleistungsangebote redaktionelle Inhaltserstellung Projektverwaltung Übersetzung Ihrer Dokumente Konfektionierung von Lieferungen Versand Archivierung Systembetreuung RJ 11/2/2020 27/28

Technische Dokumentation ____________________________________________________________________________________________________________________ Vielen Dank für Ihre Geduld und Aufmerksamkeit! Falls Sie noch Fragen haben, setzen Sie sich unverbindlich mit uns in Verbindung. GISCO Gmb. H Informationssysteme Technische Dokumentation Bachstrasse 8 88090 Immenstaad Geschäftsführer Rolf Gibbert (+49) 07545 3676 rg@gisco. de Projektleitung, Contentmanagement Dr. Ralf Jäger (+49) 07545 3681 rj@gisco. de Schnittstellen, Dokumentationstools, Web-Erstellung Dr. Joachim Ostheim (+49) 07545 94 99 042 jo@gisco. de RJ 11/2/2020 28/28