Online-Dokumentation

Transkript

1 Online-Dokumentation Keine Bücher mehr? Referent: Dietrich Juhl Online-Dokumentation Folie 1 Keine Bücher mehr? In Zukunft elektronisch? für meinen Rasierapparat? mit dem Laptop unters Auto kriechen? Lesen am Bildschirm? Online-Dokumentation Folie 2

2 Vorbemerkung: Bandbreite der Technischen Dokumentation interne Doku Lastenheft Pflichtenheft Risikobewertung Methodendokumentation Entwicklungsdokumentation Konstruktionsunterlagen Fertigungspläne Testdokumentation Außerdem: große Bandbreite an Geräten Konsumergeräte Messgeräte / Steuerungen Anlagen externe Doku Prospekte Kataloge Konfigurationshilfen Anleitungen Installationsanleitung Betriebsanleitung Wartungsanleitung Serviceanleitung... Spezialformen Kurzanleitung Schnelleinstieg Ersatzteilkatalog Online-Dokumentation Folie 3 was ist Online-Doku? elektronisch gespeichert elektronisch präsentiert elektronisch verteilt Beispiele PDF Windowshilfe Internet und andere! Online-Dokumentation Folie 4

3 Wir sind längst online in Google 1,2 Mio. Funde beim Suchwort Bedienungsanleitung filetype:pdf Online-Dokumentation Folie 5 Der große Vorteil: einfacher Prozess + weniger Kosten Online-Dokumentation Folie 6

4 Mobile Nutzung wird immer wichtiger Tablet SmartPhone Laptop ibook-reader PDA Soll die Online-Doku auch auf mobilen Geräten benutzt werden? Skalierbares Layout Angepasste Navigation Online-Dokumentation Folie 7 Herstellersicht Vorteile Nachteile Sehr kostengünstig! (Satz und Druckkosten entfallen) Unsicherheit, ob Online-Doku genügt Farbe kostenlos möglicher Datendiebstahl Viel schneller (es müssen keine Zeiten für Satz und Druck eingeplant werden) unkomplizierter (weniger Schritte, keine Auflage...) einfacher aktuell zu halten sofort kontrollierbar schnell änderbar mitwachsenden Doku ist möglich zusätzliche Möglichkeiten (Multimedia, Statistik, Feedback...) Online-Dokumentation Folie 8

5 Benutzersicht Vorteile Übersichtliches Menü (in Explorertechnik) Volltextsuche führt schnell zu einem Ergebnis Einfache Linkverfolgung Zum Nachschlagen eignet sich Online-Doku besser umfangreiche Doku lieber online zusätzliche Möglichkeiten erleichtern das Verstehen Nachteile Der Hersteller spart sich die Druckkosten und bürdet sie mir auf Noch sind wir Lesen auf Papier gewohnt Lesen am Bildschirm ist mühsamer besonders beim Einarbeiten ist Online-Doku mühsamer Online-Dokumentation Folie 9 Formate (Erscheinungsbild) Textbasierte Formate Buch mit Seiten Online-Doku mit Inhaltsverzeichnis in Explorertechnik andere...? Wissensdatenbank (FAQ, Forum, KI,...) Detaillierung per Popup StepByStep (event. mit Sprachausgabe und Sprachsteuerung) Multimedia Animation Simulation Konfigurator Video Utility Film Tutorial Augmented Reality elearning Datenbank (z.b. Ersatzteilkatalog) Ausblick Online-Dokumentation Folie 10

6 Ausgangspunkt Buch Lineare Information Hierarchisch gegliedert (Kapitel) Diverse Hypertext-Elemente Hypertext: auf unterschiedlichen Wegen lesbar Inhaltsverzeichnis Stichwortverzeichnis Fußnoten Kastentexte (z.b. Exkurse) Zusammenfassung und viele mehr... Das kennen wir... das können wir... Online-Dokumentation Folie 11 PDF Seiten genau wie Buch leicht herstellbar leicht parallel zur Papierversion leicht ausdruckbar hohe Abbildungssicherheit Herstellung Drucken über PDF-Druckertreiber Verteilung Bereitstellung auf Server Verteilung auf CD per zuschicken Benutzung Am Bildschirm, wie Buch Nachteile Download, keine Kontrolle mehr, Doku veraltet beim Anwender Seitenumbruch Keine zusätzlichen Möglichkeiten (z.b. Feedback, Statistik) Online-Dokumentation Folie 12

7 epub Seiten genau wie Buch anpassbares Layout (Schriftgröße) Herstellung Export aus Textprogramm oder Konvertierung Verteilung auf Server, auf CD, per in Shop gegen Bezahlung Benutzung wie Buch Nachteile Download, keine Kontrolle mehr, Doku veraltet beim Anwender Keine Interaktionen Keine zusätzlichen Möglichkeiten Online-Dokumentation Folie 13 Onlinehilfe kennt jeder Anwender Übliche Bedienelemente Inhaltsverzeichnis Index Volltextsuche Favoriten Dateiformate Windows (HTML-Help) Java-Help HTML (Standard!) Online-Dokumentation Folie 14

8 andere Formate...? Wissensdatenbank alles Wissen ist in einer Datenbank gespeichert und kann dort abgefragt werden gibt es ansatzweise als FAQ, Forum, KI,... Detaillierung per Popup Ein kompakter Text mit Wissensblasen als PopUp (ideal für heterogene Zielgruppe) StepByStep Handlungsanleitung jeder Schritt ist auf einer eigenen Seite möglicherweise mit Bild Text wird vorgelesen (per synthetischer Sprache kann durch Sprache gesteuert werden ( Weiter, zurück, noch mal ) in Zukunft mehr... Online-Dokumentation Folie 15 Zusätzliche Möglichkeiten Je nach Technik sind zusätzliche Features möglich Einfache Vorteile Volltextsuche Verlinkung (Inhaltsverzeichnis, Querverweise) Farbe kontextsensitive Einbindung (bei Software) Andere Darstellungen Aufklapptexte Popup Infos Einbindung neuer Medien (Ton, Video) Benutzungs-Statistik integrierte Feedbackmöglichkeit mitwachsende Doku (stetige Verbesserung) angepasstes Layout (z.b. bei mobiler Nutzung) Online-Dokumentation Folie 16

9 Aufklapptexte PopUp-Infos Online-Dokumentation Folie 17 Benutzerstatistik Online-Dokumentation Folie 18

10 Feedback-Funktion Auf jeder Seite kann der Benutzer eingeben: Kommentare Hinweise Fragen Freischaltung durch Admin oder direkt Vorteile Dialog mit dem Anwender Anwender wissen manchmal mehr als wir Anleitung kann stetig verbessert werden Online-Dokumentation Folie 19 Was ist für Sie wichtig, wenn Sie Online-Doku einsetzen? Kostenvorteil 20 Zeitvorteil 18 einfache Updatemöglichkeit 22 einfache Herstellung auf Knopfdruck aus Quelldokument 18 Lesbarkeit beim Anwender Standardformat PDF, HTML, epub 11 mobile Nutzung 7... auch auf Smartphones 0 zusätzliche Möglichkeiten Statistik 23 Feedback 27 Multimedia 17 (jeweils von ca. 50) Online-Dokumentation Folie 20

11 Wie kommen Sie zur Online-Doku? Konzept Beispiele Format des Quelldokuments Word Word Format der Online-Doku PDF HTML Tool (Quelle Online) Acrobat OfficeHelp Platz auf Server URL für Online-Doku Erstellung Konvertieren in Onlineformat Upload Kontrolle Restdoku Einfach-Anleitung zur Beilage zum Produkt mit URL für Online-Doku Online-Dokumentation Folie 21 Onlinestellen als Service Dokument wie immer (Gliederung, Text, Tabellen, Grafik) Word oder HTML uploaden Funktionen stellt der Server Menü, Volltextsuche, Statistik, Feedbackfunktion, mobliles Layout,... Online-Dokumentation Folie 22

12 jetzt sehen Sie Beispiele Online-Dokumentation Folie 23 der richtige Mix (zwischen Papier und Online-Doku) Möglichkeit 1: Papier und Online parallel Papier und PDF mit gleichen Seitenzahlen als Alternative, als Ersatz für verlorene Anleitung Möglichkeit 2: Schwerpunkt Online (und alternativ Paier) richtige Online-Anleitung bei Bedarf Papier liefern Möglichkeit 3: Online und Restdoku Zum Gerät wird nur eine kleine Papierdoku geliefert Normalbedienung Hinweis auf Online-Doku Möglichkeit 4: Nur Online-Doku Hinweis auf Online-Doku (als URL oder finden Sie auf der CD) Online-Dokumentation Folie 24

13 Rechtliche Aspekte Worauf kommt es dem Gesetzgeber an? Sicherheit der Anwender Der Anwender muss, auch wenn er über kein Abspielgerät verfügt, sicher handeln können. (Umgang mit der Technik m.e.... kann auch online erfolgen, wenn ein Abspielgerät beim Anwender vorausgesetzt werden kann) Auf jedem Fall Sicherheitshinweise auf Papier! Sicherheitsrelevante Bedienung auf Papier Kein Problem bei Software (da ist das Abspielgerät ja vorhanden) m.e. bei Serviceanleitungen (Professionalität kann vorausgesetzt werden) Siehe auch tekom Schriftenreiche Band 15: Medientechniken und Gewohnheiten... Online-Dokumentation Folie 25 BAID Identnummern für TD Sinnvoll wären eindeutige IDs für Anleitungen Klare Zuordnung Gerät Anleitung ggf. googeln nach der Anleitung mit Hilfe der ID ggf. scannen der ID mit der Smartphone-Kamera Online-Dokumentation Folie 26

14 URLs bei online-doku.de online-doku.de/sigma2317 beliebiger eindeutiger Name online-doku.de/ndv/handbuch1700 Firma, beliebiger eindeutiger Name in Frame auf Ihrem Server Frame: nur erste Seite wird von Google indiziert per vss auf Ihrem Server vss: online-doku ist nicht sichtbar. alle Seiten werden von Google indiziert Online-Dokumentation Folie 27 Didaktische Aspekte Muss eine Online-Anleitung anders geschrieben werden als eine Papieranleitung? Vielfach wird behauptet: besser gegliedert, mehr auf den Punkt, kürzere Topics m.e. gilt das für jede Anleitung allerdings fällt z.b. eine schlechte Struktur bei Online noch mehr auf. m.e. kann der Inhalt einer Papieranleitung auch als Onlineversion benutzt werden Online-Dokumentation Folie 28

15 Flexibles Layout für mobile Anwendung Normale Seiten sind starr (feste Breite, fixer Umbruch) auf kleinen Bildschirmen wird alles verkleinert, bis es passt Flexibles Layout Schriftgröße bleibt Text fließt neu im neuen Satzspiegel Probleme Tabellen benötigen meist eine gewisse Breite Bilder ebenfalls Online-Dokumentation Folie 29 Tools um Online-Doku zu erzeugen Konvertieren aus Word/FrameMaker Abspeichern als HTML WebWorks epublisher Abspeichern aus DTP/CMS OfficeHelp (auf Wordbasis) DocuGlobe Author-it Robohelp MadCap Flare TIM-RS (auf FrameMaker-Basis) Schema ST4 Online-Dokumentation Folie 30

16 Problemfelder der TD Aufwand Erstellung Übersetzung Verständlichkeit Rechtssicherheit Versionen und Varianten Tools und Dateiformate Online-Dokumentation Folie 31 Datendiebstahl Was tun? Es gibt keine Möglichkeit Daten zu sichern Was online ist, kann weltweit geklaut werden Jede Verschlüsselung oder Passwortschutz kann geknackt werden (und wird geknackt, wenn das Objekt interessant genug ist) Strategie bei Doku Trotzdem Zugang erschweren mehr Zurückhaltung mit der Preisgabe von Infos (Interna, z.b. Funktionsweise nicht rausgeben) beschränken auf die Info, die der Kunde braucht Besser und schneller sein, als die Konkurrenz Online-Dokumentation Folie 32

17 Ausblick Auf dem Weg von der Papierdoku zur Online-Doku stehen wir ganz am Anfang! Online-Dokumentation Folie 33 andere Formate...? bisher: Buchseiten erst langsam entwickeln sich neue Formen, die anders sind als ein Buch Wissensdatenbank alles Wissen ist in einer Datenbank gespeichert und kann dort abgefragt werden Detaillierung per Popup Ein kompakter Text Wissensblasen als PopUp StepByStep Handlungsanleitung jeder Schritt ist auf einer eigenen Seite Video häufig viel anschaulicher als Text und Bild Multimedia Animationen und Simulationen Interaktion elearning mit Lernkontrolle Online-Dokumentation Folie 34

18 Video Tutorial eine Bedienung wird exemplarisch gezeigt und dabei erklärt eignet sich sehr gut, um die Möglichkeiten zu zeigen um die prinzipielle Vorgehensweise zu zeigen viele Beispiele in Youtube (Suche Tutorial ) Utility Film ganz einfach herzustellen? (5 Std. Produktionszeit für 30 min Film) Gerät oder Bedienung werden gezeigt (meist sprachneutral) unterstützt durch Grafiken oder Hervorhebungen Film stoppt nach jedem Schritt Online-Dokumentation Folie 35 Multimedia Viele Medien auf einem Gerät Text Bild Video Ton Interaktion! Sehr gut geeignet für Animation (bewegte Bilder, z.b. Funktionsweise) Simulation (bedienbar wie Original, z.b. Flugsimulator) Online-Dokumentation Folie 36

19 Multimedia Animation sehr gut geeignet zur Darstellung komplexer Inhalte Online-Dokumentation Folie 37 Multimedia Simulation sehr gut geeignet zur Darstellung und zum Erlernen einer Bedienung (nicht alles lässt sich simulieren) Online-Dokumentation Folie 38

20 noch mehr Zukunftsmusik... mobile, persönliche Geräte eingebaute Kamera, Bluetooth, Mac-Adresse dadurch neue Möglichkeiten denkbar Denkbare Anwendungen Identifikation per BAID Individualisierung durch Nutzererkennung Online-Dokumentation Folie 39 Augmented Reality (= Erweiterte Realität) Anleitung am Objekt Hinweise werden in Realbild eingeblendet Online-Dokumentation Folie 40

21 Links Online-Doku BMW Augmented Reality: Utilityfilm-Beispiel: Tutorials-Beispiele in Youtube Online-Dokumentation Folie 41 Ende Online-Dokumentation Folie 42

22 Anfang Online-Zusammenarbeit Online-Dokumentation Folie 43 Projektabwicklung Anfrage, Angebot, Auftrag Recherche Erstellung Klärung offener Fragen Fertigstellung Lieferung Korrekturlauf beim Auftraggeber Lieferung der Korrekturen oder Redaktionskonferenz Einbau der Korrekturen Lieferung der fertigen Anleitung Online-Dokumentation Folie 44

23 Remote-Tool Voraussetzungen: DSL auf beiden Seiten Parallel telefonieren Tools ISL-Online (390 /Jahr) Teamviewer (500 ) Online-Dokumentation Folie 45 Verbindungsaufbau nah Tool runterladen fern Tool starten Code eingeben ansehen / zeigen zustimmen Online-Dokumentation Folie 46

24 Recherche mit Remote Software gemeinsam durchspielen auf Rechner des Zeigers nicht zu schnell zeigen lassen Unterlagen gemeinsam ansehen Online-Dokumentation Folie 47 Klärung offener Fragen mit Remote Anmerkungen, Fragen im Text farbig markiert und mit XXX Langsam durchscrollen der andere soll überfliegen aber noch nicht durchlesen er soll ggf. Auffälligkeiten nennen Fragen klären richtige Formulierung nach Möglichkeit sofort in Text einbauen und bestätigen lassen Vorteile beide sehen das gleiche Dokument Vorgang geht schneller als live Online-Dokumentation Folie 48

25 Coaching oder Hilfe bei Computerproblemen mit Remote Coaching Unterstützung beim Schreiben Umgang mit Tool (z.b. Word) Beispiel Hilfe per Remote Abrechnung minutenweise Online-Dokumentation Folie 49 Ende Vielen Dank für Ihre Aufmerksamkeit Online-Dokumentation Folie 50