Help Authoring Tools (HATs) Marktüberblick und Entscheidungshilfen

Transkript

1 Help Authoring Tools (HATs) Marktüberblick und Entscheidungshilfen Marc Achtelig, Dipl.-Ing.(FH), Dipl.-Wirtschaftsing.(FH) Handbücher Online-Hilfen Demos und Tutorials Texte für Benutzeroberflächen Texte für Websites und Broschüren

2 Agenda Workflows, Szenarien, Toolgruppen Worauf Sie achten sollten Wie Sie objektiv und begründbar entscheiden (Pause) Tools live Diskussion 2

3 Workflow-1: Konverter Editor und Hilfe-Generator sind komplett entkoppelt Ausgangsbasis sind fertige Dokumente, die in einem zweiten Schritt in ein Online- Hilfe-Format konvertiert werden Word FrameMaker HTML-Dateien XML-Dateien 3

4 Workflow-1: Konverter Vorteile bestehende Prozesse können weitgehend unverändert bleiben effizient, wenn bereits entsprechendes Ausgangsmaterial besteht Nachteile begrenzte Flexibilität hinsichtlich des erzielbaren Outputs Buch-Metapher (Word / FrameMaker) kann zu Qualitätseinbußen führen fehleranfällig, falls sich Autoren nicht streng an Formatvorgaben halten Single Source Publishing für mehrere Produktvarianten schwierig umsetzbar 4

5 Workflow-2: Anbindung externer Editor HAT als "add on" (Plug-in) zu einem Standard-Editor wie Microsoft Word Adobe FrameMaker HTML-Editoren XML-Editoren 5

6 Workflow-2: Anbindung externer Editor Vorteile Funktionen eines bereits bekannten und vorhandenen Editors können weiter genutzt werden teilweise bessere Akzeptanz (Word...) Nachteile begrenzte Effizienz, da nicht in das Gesamtkonzept des Editors integriert Quelldaten mit Metainformationen "angereichert", daher fehleranfällig, insbes. im Übersetzungsprozess "erbt" Probleme des benutzten Editors 6

7 Workflow-3: Integrierter Editor In das HAT ist ein (WYSIWYG / WYSIWYM) Editor integriert Inhalte und Strukturen werden im HAT verwaltet Output wird aus dem HAT heraus generiert Desktop oder webbasiert 7

8 Workflow-3: Integrierter Editor Vorteile Inhalte und Meta-Informationen werden zusammen erstellt und gepflegt Keine zusätzlichen Lizenzkosten für einen externen Editor Geringer Installations- und Pflegeaufwand der Tool-Umgebung Nachteile Integrierte Editoren bieten nicht immer denselben integrierten Komfort wie z.b. Word (Autotext, Tastenkürzel für Formate, Makros, Qualität der Rechtschreibprüfung) 8

9 Sonderfall: Automatisierte Tools Source Code Scanner Schwerpunkt: Dokumentation von Programm- Bibliotheken Rapid Help Authoring Tools Scan von Resource Files Task Recording Schwerpunkt "Quick-and-Dirty- Dokumentation" unter Zeit-/Budget-Restriktionen bei Anwendungen mit geringer Benutzerzahl als Ergänzung zu Training und Support 9

10 Weitere Wege zur Online-Hilfe HTML-Editoren + reine Compiling Tools Content Management Systeme und individuelle Lösungen Wikis... 10

11 Zusammenfassung Konverter Anbindung an externen Editor integrierter Editor 11

12 Optional: Postprocessing / Automation Automatisierte Modifikation des durch ein HAT erzeugten HTML-Codes Hinzufügen durch ein HAT nicht unterstützter Funktionen Automatisierung im HAT nicht automatisierbarer Abläufe Beispiele AutoHotkey ( 0) CHM2Web ( 130) Replace Text, Text Workbench ( 0 / 50) Zoom Indexer ($99) 12

13 Agenda Workflows, Szenarien, Toolgruppen Worauf Sie achten sollten Wie Sie objektiv und begründbar entscheiden (Pause) Tools live Diskussion 13

14 Grundfragen Lizenzkosten Nutzung auf verschiedenen Rechnern möglich? Floating-Lizenz verfügbar? Wartungskosten Lieferumfang Screen Capture Tool enthalten? Bildeditor enthalten? Import von Altdaten? Einarbeitungsaufwand? Usability? Kompatibilität mit persönlichen Arbeitsweisen / Präferenzen / Abneigungen? 14

15 (Leider nicht) selbstverständliches Browser-basierte Hilfen unter allen Browsern lauffähig, oder nur unter IE und Firefox? Browser-basierte Hilfen kontextsensitiv aufrufbar? Problem Framesets? IDs vergebbar? Dateinamen konstant und beeinflussbar? Formatierung konsequent über vordefinierte Absatz-, Zeichen- und Tabellenformate, oder nur "harte" Formatierungen? 15

16 Flexibilität Generierter HTML-Code beeinflussbar? Templates Code Snippets / Pass-through Code Unterstützung moderner Navigation- und Interaktionselemente? Breadcrumb Trail Tab Cards Expandable Sections Related-Topic-Links Mini TOCs... 16

17 Übersetzungsprozess Unicode-kompatibel? Translation-Memory-kompatibel? XML Roundtrip Import/Export? Filter für TMS vorhanden? Übersetzung und parallele Pflege mehrerer Sprachen im HAT? Vereinfachter und fehlersicherer Editor für Übersetzer verfügbar? 17

18 Arbeit im Team Gleichzeitiges Arbeiten mehrerer Autoren an einem Projekt möglich? Remote-Zugriff möglich? Integrierte Versionskontrolle? Anbindung an Version Control System möglich? Unterstützung für Review-Prozess? Unterstützung der Zulieferung von Inhalten durch "Subject Matter Experts" (SMEs)? 18

19 Single Source Publishing Nicht nur Medien sondern auch unterschiedliche Varianten generierbar? Export mit Styles? Ersetzen medientypischer Textfragmente, z.b. in Querverweisen? Bedingte Texte? Conditional Text Build Flags Textvariablen Mehrfachverwendung von Inhalten? (Embedded Topics, Text Insets, Text Snippets) 19

20 Single Source Publishing Ist die Produktion mehrerer Dokumente (Varianten) automatisierbar? Kann die Produktion mit allen erforderlichen Parametern und Einstellungen von der Kommandozeile oder über Scripts gestartet werden? 20

21 Strategische Fragen Was passiert, wenn der Hersteller nicht mehr existiert oder das Produkt einstellt? Läuft das Tool nur auf einen Server beim Hersteller? Muss das Tool bei einer Neuinstallation aktiviert werden? Lässt sich das Tool zumindest für eine Übergangsphase weiterhin nutzen? Wie einfach können Sie in Zukunft bei Bedarf auf ein anderes Tool umsteigen? Im obengenannten Fall Falls die Lösung zu klein wird Sind die Daten in einem offenen Format, z.b. XML speicherbar? Können Sie nur den Output exportieren, oder auch alle Metadaten? 21

22 Agenda Workflows, Szenarien, Toolgruppen Worauf Sie achten sollten Wie Sie objektiv und begründbar entscheiden (Pause) Tools live Diskussion 22

23 "One size fits all"? "Das" beste Tool kann es nicht geben Das Optimum hängt von den individuellen Gegebenheiten und Anforderungen ab 23

24 Nutzwertanalyse Kein Tool wird den Anforderungen zu 100% entsprechen Systematische Entscheidungstechnik findet das Tool, das in Summe den individuellen Anforderungen am weitesten entspricht (individuelles Optimum) objektiv vorurteilsfrei begründbar dokumentierbar nachvollziehbar 24

25 Nutzwertanalyse Berücksichtigt individuelle, gewichtete Kriterien Kann auch Kriterien einbeziehen, die nicht in Zahlen messbar sind Qualität Benutzerfreundlichkeit Systematische Auflistung und Gewichtung von Kriterien verschafft Klarheit über eigene Ziele Kann optional mehrere Personen in den Entscheidungsprozess einbinden Betroffene Vorgesetzte 25

26 Fallbeispiel Entscheidung für die Einführung eines neuen Help Authoring Tools zur Erstellung von Online-Hilfen und Handbüchern (PDF) aus einer Quelle (Single Source Publishing) ca Seiten Updates pro Jahr 2 Autoren beteiligt Übersetzung ins Chinesische sowie in weitere Fremdsprachen 2 Versionen ("Standard" und "Professional") 26

27 Fallbeispiel Schritt-1: Identifizieren Sie die in die engste Auswahl kommenden Alternativen Sortieren Sie alle Alternativen aus, die einem oder mehreren KO-Kriterien nicht entsprechen (hier z.b. alle Tools, die keine asiatischen Sprachen unterstützen) Identifizieren Sie die Alternativen (ca. 2 bis 5 nicht mehr), die in die engere Auswahl kommen (hier z.b. "RoboHelp", "Flare", "Help & Manual") 27

28 Fallbeispiel Schritt-2: Stellen Sie eine Kriterienliste auf Schreiben Sie alle Kriterien auf, die Ihre INDIVIDUELLE Entscheidung beeinflussen. Nicht alle Kriterien müssen in Zahlenwerten messbar sein. Sie können auch qualitative Kriterien verwenden. Prüfen Sie, ob sich kein Kriterium mehrfach unter verschiedenen Bezeichnungen eingeschlichen hat. Dies würde das Ergebnis verzerren. Arbeiten Sie ggf. mit Ober- und Unterkriterien. Schreiben Sie hinter jedes Kriterium die Gewichtung, die dieses Kriterium für Sie INDIVIDUELL hat. entweder muss die Summe aller Gewichte 100% ergeben oder Sie müssen am Ende jedes Gewicht durch die Summe aller Gewichte teilen 28

29 Fallbeispiel Eine vereinfachte Kriterienliste könnte z.b. wie folgt aussehen: Qualität des HTML-Outputs (Online-Hilfe) 30% Qualität des PDF-Outputs (Handbuch) 10% Single-Sourcing-Effizienz 30% Feature XY 10% Kosten (20%) Aufwand für Anpassung 10% Aufwand für Einarbeitung 5% Lizenzkosten 5% Gesamt 100% 29

30 Fallbeispiel Schritt-3: Bewerten Sie die Alternativen und berechnen Sie die Nutzwerte Verwendeter Maßstab: 1 (Kriterium kaum erfüllt) (Kriterium optimal erfüllt) Achtung: Ein hoher Zahlenwert ergibt nicht immer eine hohe Punktezahl. Beispiel: Hohe Kosten sind unerwünscht und erhalten daher wenig Punkte! Kriterium Gewicht [%] RoboHelp Flare Help & Manual Qualität HTML Output ,4 8 2,4 10 3,0 Qualität PDF Output ,5 9 0,9 7 0,7 Single-Sourcing-Effizienz , ,4 Feature XY ,5 8 0,8 9 0,9 Aufwand für Anpassung ,7 6 0,6 8 0,8 Aufwand für Einarbeitung 5 3 0,2 3 0,15 9 0,5 Lizenzkosten 5 1 0,1 5 0, ,5 Nutzwert 4,9 8,1 8,8 30

31 Fallbeispiel Hinweise zum Ergebnis: Die Ergebnisse sich NICHT allgemeingültig. Die Ergebnisse hängen von Ihren INDIVIDUELLEN Kriterien, Gewichtungen und Bewertungen ab. Dies ist keine Schwäche des Verfahrens, sondern seine Stärke. 31

32 Sensitivitäts-Analyse (Was-wäre-wenn) Sollte folgen wenn die ermittelten Nutzwerte eng beieinander liegen wenn Sie sich bei einzelnen Bewertungen unsicher waren Variieren Sie einzelne Gewichte und Bewertungen, und beobachten Sie deren Auswirkungen auf das Ergebnis. Entscheiden Sie sich im Zweifel für die Lösung mit dem stabileren Ergebnis. 32

33 Berücksichtigung von Kosten Einfachste Lösung: Kosten direkt als Kriterium aufnehmen (siehe vorheriges Beispiel). Wenn Sie Kosten und Nutzen gegenüberstellen möchten: Führen Sie zuerst eine Nutzwertanalyse ohne jegliche Berücksichtigung von Kosten durch. Dividieren Sie anschließend die ermittelten Nutzwerte jeder Lösung durch deren Kosten. Dies ergibt dann den erzielten Nutzen pro investierter Geldeinheit. Die Alternative mit dem größten relativen Nutzen ist dann zu bevorzugen. 33

34 Entscheiden im Team Vorteile: Experten können Fachwissen einbringen. An der Entscheidung beteiligte Personen werden später auch deren Umsetzung aktiv unterstützen (keine "Entscheidung über die Köpfe hinweg"). So organisieren Sie eine Team-Entscheidung Alternative 1: Abhängig vom Fachwissen nimmt jedes Team-Mitglied einen Teil der Bewertungen vor. Geeignet, wenn nicht alle Teilnehmer zu allen Kriterien fundierte Bewertungen vornehmen können. Alternative 2: Die Gruppe einigt sich zu jedem Punkt auf eine gemeinsame Bewertung. Nachteil: Besonders durchsetzungsstarke Team-Mitglieder (Meinungsführer) können die Entscheidung dominieren und führen dadurch zu Verzerrungen im Ergebnis. Alternative 3: Jedes Team-Mitglied nimmt alle Bewertungen alleine vor. Anschließend wird aus den einzelnen Bewertungen der Mittelwert gebildet. Geeignet, wenn kein spezielles Expertenwissen erforderlich ist, oder wenn alle Team-Mitglieder über dasselbe Expertenwissen verfügen. 34

35 Agenda Workflows, Szenarien, Toolgruppen Worauf Sie achten sollten Wie Sie objektiv und begründbar entscheiden (Pause) Tools live Diskussion 35

36 Agenda Workflows, Szenarien, Toolgruppen Worauf Sie achten sollten Wie Sie objektiv und begründbar entscheiden (Pause) Tools live Diskussion 36

37 Tools live Konverter Word-2-Web / Word-2-CHM (ca. $300) ReWorx (ca. 200) WebWorks epublisher (auf Anfrage) (Word + Doc-To-Help) (Word-Import in andere Tools) (FrameMaker / Word + RoboHelp) 37

38 Tools live Tools mit Anbindung an externen Editor OfficeHelp (ca. 300/600) Doc-To-Help (ca. $1000) MGTEK Help Producer (ca. $400) XDK (ca. $500) 38

39 Tools live Tools mit integriertem Editor HelpMaker (kostenlos) HelpNDoc (ca. $0+) HelpSmith (ca. $120) HelpConsole (ca. $300+) Help&Manual (ca. $500) Flare (ca. $1000) RoboHelp (ca. $1000) Oxygen XML Editor (ca. $450) XMetaL (ca. 1175) AuthorIT (auf Anfrage) nqdoc (ca. 60) digipedia (ca. 810) 39

40 Tools live Automatisierte Tools Doc-O-Matic (ca. 755) Doc-O-Matic for Authoring (ca. 235) Document! X (ca. 350) HelpStudio (ca. 350) Dr. Explain (ca. $165) ScreenSteps (ca. $80) 40

41 Agenda Workflows, Szenarien, Toolgruppen Worauf Sie achten sollten Wie Sie objektiv und begründbar entscheiden (Pause) Tools live Diskussion 41

42 Handbücher Online-Hilfen Demos und Tutorials Texte für Benutzeroberflächen Texte für Websites und Broschüren