Herzlich Willkommen!
Der Vortrag
OneSourceDocs
beginnt in wenigen Minuten
Willkommen!
Herzlich willkommen zu meinem Vortrag
OneSourceDocs
Ferdinand Soethe
mail@soethe.net
Zu meiner Person ...
Ferdinand Soethe
- Softwarearchitekt, Autor
und Berater
- Mitglied des Apache Forrest PMC
- Aktueller Arbeitsschwerpunkt: SSP-Systeme
Motivation Praxis
- Praxis eines großen Software-Projekts.
- Präsentationsunterlagen und Dokumentation einer
bankfachliche Anwendung.
Dokumentationsanforderungen
- Fortlaufende Anpassung der Dokumentation
- Neue Funktionalitäten in der Presales-Phase
verständlich beschreiben.
- Ausführliche Angebotsdoku für den internen Bedarf des
Kunden.
- Hilfestellungen für Vertriebsbeauftragte
- Erweiterte Doku für Vorbereitungsworkshops und
Schulungen
- Rekombination ausgewählter Funktionsmodule für
Angebote an neue Kunden
- Weiterverwendung von Inhalten für Handbuch und
Online-Hilfe
Praxis
Mehrfache Nutzung von Material bringt viele praktische
Probleme:
- Neue Vorträge entstehen durch Kopieren und Ändern
vorhandener Powerpoint-Dateien
- Neue Folienversionen entstehen oft im
Vorbeiflug
Tool-Probleme
Hinzu kommen Probleme mit den verwendeten Standardtools:
- Mangelnde Unterstützung für Single Source Publishing
- Fehlende Unterstützung von modularer
Dokumentation
Anspruch OneSourceDocs
OneSourceDocs ist kein Produkt sondern
- praktische Suche nach besseren Lösungen
- Belastbarkeitstest für XML-Technologien (XML, HTML,
PDF, Forrest)
- Spielfeld für neue Ideen
Grundgedanken OneSourceDocs
Ziel von OneSourceDocs ist die Umsetzung von Single
Sourcing in Dokumentation und Präsentation.
- Integration von Präsentation, Schulungsunterlagen und
Handbuch in einer Quelle
- Maximale Wiederverwendbarkeit von Inhalten
- Plattformunabhängige Programmierung
- Versionierbarkeit von Inhalten
- Einfache Integration verschiedener Quellen
Was kann OneSourceDocs
Die Möglichkeiten von OneSourceDocs sehen wir am besten
mit einem Blick hinter die Kulissen:
Themenzentriert
Topics sind Grundbaustein und thematische Einheit
- Inhalte für Präsentation und Dokumentation
- Durch Sections weiter gliederbar
- In Präsentationen wird das Topic zur Folie
Natürliche Elementnamen
Angelehnt an HTML, verwendet die Grammatik sprechende
Namen für Elemente und Attribute.
- Einfacher zu erlernen
- leichter zu lesen
Single Source Publishing
Alle Elemente sind in Präsentation oder Dokumentation
sichtbar, können aber auch ausgeblendet werden um
- Begrüßungsfolien in Dokumentation und
Teilnehmerunterlagen wegzulassen
- kurze Stichpunkte einer Präsentation für
Teilnehmerunterlagen und Dokumentation ausführlicher zu
fassen.
- Folienmaterial durch ausführliche Dokumentation zu
ergänzen.
Die Sichtbarkeit wird bei Bedarf durch Attribute
showOnlyFor="print/slides/..." beschränkt
Struktur
Struktur durch Gliederungsmöglichkeiten
- Topics kapseln einzelne Themen (wie DITA)
- Modules fassen Topics zu wiederverwendbaren Einheiten
zusammen
- Chapter gliedern Vortrag und Präsentation in
Kapitel.
Automatismen
Automatismen sparen Arbeit und vermeiden Fehler:
- Variablen-ähnliche Elemente wie
<PresentationTitle/> für Titel oder andere
Metadaten
- Macros wie <TOC/> und
<chapterTOC/> für Inhaltsverzeichnisse auf
globaler oder Kapitelebene
- Zusätzliche Attribute für Aufnahmen oder Ausblendung
von Inhalten aus dem Inhaltsverzeichnis.
Präsentationshilfen
Mit speziellen Elementen wie <talk/> oder
<demo/> können Hinweise für Präsentierende
direkt in der Doku abgelegt werden
Mithilfe der dualen Präsentation sind diese nur auf dem
Laptop, nicht aber für das Publikum sichtbar.
Lesezeichen für Aufgaben
Noch zu Erledigendes kann mit
<todo/>-Elementen direkt im Text eingestellt
werden.
XML als Quellsprache
XML als Quellsprache bietet viele Vorteile
- Flexible, sichere Verarbeitung
- Gut versionierbare Quelldateien
- Freie Wahl des Editorwerkzeugs
- Rekombinierbarkeit mit XInclude
Spezialisierte, erweiterbare Grammatik
- Optimiert für die Bedürfnisse von OneSourceDocs
- Alle Funktionen von der Grammatik definiert und sicher
editierbar
Apache Forrest
- Plattformunabhängiges Werkzeug
- XML-Transformationspipelines
- XInclude-Unterstützung
- Ideale Unterstützung des SSP-Konzepts
- Navigationsoberfläche für Module und fertige
Präsentationen
PDF mit XSL-FO und FOP
- PDF: zur Zeit weitest verbreiteter Standard für
gedruckte Dokumentation
- XSL-FO: flexibelster und mächtigster Weg zu
PDF
- Apache FOP 0.94: standardkonforme Open Source
Implementierung
Slidy Technologie
Slidy von Dave Raggett erlaubt die Präsentation von
Inhalten im Web-Browser
- Automatische Skalierung der Seiten
- Blättern mit Maus oder Pfeiltasten
- Einfache Anpassung der Schriftgröße
- Viele Komfortmerkmale
Subversion
Für die rein textbasierten Quelldateien läßt sich
Subversion als hervorragendes Versionskontrollsystem
verwenden.
- Einfache, zuverlässige Versionierung
- Zweige (Branches)
- Zusammenarbeit über das Internet
- Offline-Arbeiten
