Reuse-Faktor bei der Dokumentation. Embedded Software. Comet Communication GmbH 10. Dezember 2009 Elke Grundmann Comet Communication GmbH

Transkript

1 Reuse-Faktor bei der Dokumentation für Embedded Software Comet Communication GmbH 10. Dezember 2009 Elke Grundmann

2 Wer sind wir? COMET FIRMENGRUPPE seit 1987 Comet Computer GmbH Comet Communication GmbH 75 MitarbeiterInnen

3 Comet Firmengruppe Comet Computer die Profis für Technische Dokumentation Software-Dokumentation Handbücher Online-Hilfen Schulungsunterlagen Comet Communication Die Profis für Consulting und Training Beratung Schulungen rund um die Technische Dokumentation Single-Source-System Author-it

4 Embedded Software und Software-Dokumentation Embedded Software In unterschiedlichen Systemen enthalten Große Anzahl von Komponenten Viele Schnittstellen Hohe Zuverlässigkeit Dokumentation übergreifende Dokumentation viel Dokumentation viele Schnittstellenbeschreibungen qualitativ hochwertige Dokumentation

5 Was verursacht Kosten bei der Dokumentation? unterschiedliche Ausgabeformate verschiedene Varianten mehrere Sprachen viele Versionen

6 Beispiele Unterschiedliche Funktionen in Internet und Angebot:... verfügt über umfangreiche Funktionen zur Versionierung. oder reichhaltige Variantensteuerung

7 Ansatz Single Sourcing Redundanzen vermeiden durch Single Sourcing Alle Informationen werden an einer zentralen Quelle gespeichert und verwaltet, jedoch verwendet für: unterschiedliche Ausgabeformate unterschiedliche Zielgruppen unterschiedliche Versionen

8 Single Source V2 V3 V1 Systembeschreibung Schnittstellenbeschreibungen Single Source asdklskdlaskd laskdlaskd Asdadasd asd ad ad ad d

9 Wie komme ich zu Single Sourcing? Inhalte modularisieren Subdokumente Schrittanleitungen Schnittstellenbeschreibungen Grafiken Verweise Module verwalten Module wiederverwenden Dokumente publizieren

10 Ansätze zur Modularisierung Eigenentwicklung Standard-spezifisch, z.b. DITA, S1000D Tool-spezifisch

11 Beispiel: Eigenentwicklung Wartungshandbücher Passende Informationsklassen Autorenumgebung: Word Verwaltung: Excel Publikationsformat: pdf

12 Module zusammenstellen

13 Was ist ein Topic? Topics sind in sich geschlossene, möglichst kontextunabhängige Inhaltsblöcke. Beispiele: Begriffserklärung Schrittanleitungen Voraussetzung Schritte Ergebnis Verweise TAN (Transaction Number) Geheimzahl, die bei jeder Transaktion (z.b. Überweisung) angeben wird.

14 Stolpersteine Welche Bereiche sollen eingeschlossen werden? Wie sieht die technische Umsetzung aus? Wie muss die Arbeit organisiert werden?

15 Lösung Im vertrauten Umfeld starten Modularisierung üben eine Quelle für gemeinsame Inhalte Zusammenarbeit intensivieren Organisation vorbereiten Mit kleinem Projekt starten Strukturierung überprüfen Bereiche erweitern Passende Werkzeuge auswählen

16 Topicorientierte Redaktionswerkzeuge Unterstützen den Autor bei der Modularisierung und Wiederverwendung Unterschiedliche Ausgabeformate Unterstützung bei der Übersetzung Verwaltungsfunktionen Beispiele Author-it Adobe Framemaker und RoboHelp Schema ST4.

17 Wie arbeitet ein Redaktionssystem? Beispiel: Author-it 5 CMS mit integriertem Redaktionssystem Datenbank für sämtliche Informationen Texte Grafiken Verweise Layout Topic-, objektorientierter Ansatz Verschiedene Ausgabeformate Word, PDF, InDesign HTML, XHTML, XML HTML Help, JavaHelp, Eclipse Help, WebHelp SCORM

18 Wie in Author-it mit Topics arbeiten? 1. Vorlagen definieren 2. Neue Topics auf Basis von Vorlagen erstellen 3. Bestehende Topics finden 4. Bestehende Topics wiederverwenden 5. Topics pflegen

19 Topics wiederverwenden

20 Reuse von Topics Änderung an einer Stelle

21 Wie bestehende Topics finden? Verringerung der Informationsmenge durch Single Sourcing Strukturierung Suchfunktion Authoring Memory (z.b. Author-it Xtend)

22 Finden von bestehenden Inhalten Author-it Xtend

23 Ergebnis: Dokument generieren Generierung unterschiedlicher Ausgabeformate aus einer Quelle

24 Vielen Dank für f r Ihr Interesse! Offene Fragen? grundmann@comet.de