Prof. Dr. Gertrud Grünwied (Mail: Softwaredokumentations-Normen

Transkript

1 Prof. Dr. Gertrud Grünwied (Mail: Softwaredokumentations-Normen tekom RG: Hannover, 6. Juli

2 Prognose Software und IT-Dienstleistungen Der Anteil der Software- und IT-Dienstleistungsbranche an der Bruttowertschöpfung wird bis 2030 auf 3,23% steigen. Dies entspricht ungefähr einer Verdoppelung des heutigen Wertes. (Quelle: Fraunhofer ISI, Software-Studie, Timo Leimbach, 2010)

3 DAS THEMATISCHE SPANNUNGSFELD Anforderungen aus Normen Software- Dokumentation Software-Anwendung 3

4 Überblick Produkt-Norm: IEEE 1063:2001 Software User Documentation Prozess-Normen zur Erstellung von Software- Dokumentation ISO/IEC 18019:2004 ISO/IEC 15910:1999 ISO/IEC 26514:2008 (Produkt- und Prozess-Norm auf Basis IEEE ISO/IEC 18019) Usability-Aspekte zu Software-Dokumentation 4

5 Norm IEEE 1063

6 DER STANDARD IEEE Internationaler Produkt -Standard Software-Benutzerdokumentation Ausgabe am Originalsprache: englisch 6

7 ZWECK DES STANDARDS Mindestanforderungen Gegliedert in Struktur, Inhalt und Form Gedruckte und elektronische Medien Praxisrelevanz Muster für Style Guide 7

8 DEFINITION NUTZUNGSART Die Norm unterscheidet zwei Nutzungsarten: zum Einarbeiten: instruktional Informative Inhalte Handlungsanleitungen zum Nachschlagen: beschreibend (Referenzdokumentation, kontextsensitiv) 8

9 DEFINITION SICHERHEITSHINWEISE Warnung: Ernsthafte oder gefährliche Folgen Vorsicht: Undefinierte oder unerwünschte Folgen Beispiele: Datenverlust, Geräteproblem Hinweis: Unterstützt die Benutzer bei der Arbeit 9

10 DEFINITION ARBEITSABLAUF Arbeitsablauf Arbeitsschritt Aktion Aktion Aktion Arbeitsschritt 10

11 MEDIENKONZEPT Elektronische Dokumentation Während Software-Nutzung jederzeit aufrufbar Kontextsensitive Referenzdokumentation simultan zur Software sichtbar Zusätzlich auf Papier Anforderungen an Hardware / Betriebssysteme Installationsanleitungen Anleitungen zur Fehlerbehebung, Recovery Anleitung zum Zugriff auf Hilfesystem Kontaktaufnahme mit Kundendienst 11

12 Praxisbeispiel - Normen-konforme Online-Hilfe

13 Bestandteile nach IEEE 1063 und ISO/IEC Identification data Table of contents List of illustrations Introduction Use of documentation Concept of operations Procedures Software commands Error messages Glossary Related information Navigational festures Index Search capability Yes Yes (more than 8 pages) optional Yes Yes Yes Yes (instructional mode) Yes (reference mode) Yes Yes, if unfamiliar terms Optional Yes Yes (more than 40 pages) Yes (on-screen, more than 8 pages) 22

14 AUSWAHL DES HILFEFORMATS Browserbasiert HTML Help oder WebHelp 24

15 IDENTIFIZIERENDE ANGABEN Produkt 25

16 INHALTSVERZEICHNIS Vollständigkeit, Richtigkeit, Aktualität Gliederung nach Prozesskette Max. drei Unterebenen Nutzungsarten trennen 26

17 EINFÜHRUNG IN DAS THEMA Fachbegriff einführen Text + Bild 27

18 LESEHINWEISE Hilfe zur Hilfe 28

19 BESCHREIBUNG DER BENUTZEROBERFLÄCHE Zentral 29

20 ANMELDEN UND ABMELDEN Nutzer-Gruppen unterscheiden Zentral 30

21 FUNKTIONSBESCHREIBUNG Informationen Grafik ohne Scrollen sichtbar Farben vor Hintergrund lesbar 31

22 ARBEITSABLÄUFE Zweck Nummerierte Schritte Platzierung Einheitliche Piktogramme Resultat 32

23 STRATEGISCHES HANDLUNGSKONZEPT Zusammenhang Varianten Verweise 33

24 ÜBERSICHT DER SOFTWARE-BEFEHLE Listen- oder Tabellenform 34

25 REFERENZDOKUMENTATION Einheitliche Form Datenformate 35

26 GLOSSAR Akronyme Produktspezifische Begriffe Unvertraute Begriffe 36

27 KONTAKTADRESSEN! 37

28 STICHWORTVERZEICHNIS Nutzungsart angeben Max. zweistufig Einträge zweifach 38

29 SUCHMÖGLICHKEITEN Volltextsuche 39

30 Prozess-Normen

31 STANDARDS FÜR DOKUMENTATIONSPROZESS ISO/IEC Guidelines for the design and preparation of user documentation for application software (Erstausgabe ) Richtlinie für die Gestaltung und Vorbereitung von Benutzerdokumentation für Anwendungssoftware (allgemein) ISO/IEC Software user documentation process (Erstausgabe ) Prozessmodell für die Erstellung einer Software-Benutzerdokumentation (vertraglich) 41

32 ISO 18019: ENTWICKLUNGSPHASEN 42

33 ISO/IEC

34 ISO/IEC NUTZER- GRUPPEN AUFGABEN WISSEN MEDIUM WÄHLEN NUTZER 44

35 18019: NUTZER-WISSEN-DOKUMENTARTEN Administrations-Handbuch (PDF) Benutzer-Handbuch (PDF) Nutzergruppe Informationsart Administratoren Gelegenheits- Anwender Experten Überblick Administration Allg. Merkmale Allg. Merkmale Konzepte Standard Standard Fortgeschritten Aufgaben Administration Wartung Standard Standard Fortgeschritten Online-Hilfe Referenz Felder Felder Felder 45

36 Produkt- und Prozess-Norm ISO/IEC 26514:2008

37 ISO/IEC Software-Dokumentation ISO/IEC Requirements for designers and developers of user documentation Stand: Oktober 2008 Englischsprachig Eingegliedert in internationale Normenreihe zur Software- Entwicklung System and Software Engineering Weitere Normen zur Dokumentation in Planung Fasst im Kern die IEEE 1063 und ISO/IEC zusammen Vereint Sichtweise der Prozessschritte mit den Forderungen an ein hochwertiges Dokumentationsprodukt Fokus: Benutzerdokumentation für Anwendungssoftware, aber in Teilen auch übertragbar auf Benutzerdokumentation für Systeme, die Hardware beinhalten 47

38 DEFINITIONEN Product: complete set of software and documentation Software: program or set of programs used to run a computer NOTE: does not include on-screen documentation Application software: software designed to help users perfprm particular tasks (...), as distinct from software that controls the computer itself 48

39 ISO/IEC Prozessanforderungen Die Prozess-Phasen im Überblick 1. Projektanforderungen, Ziele und Einschränkungen 2. Analyse und Konzept 3. Dokumentationserstellung und Bewertung 4. Produktion, Verteilung 5. Aktualisierung der Bausteine, Wartung, Archivierung FAZIT: Team von Experten notwendig (Informationsarchitekten, Technische Redakteure, On Screen-Designer, Usability-Spezialisten..) 49

40 ISO/IEC Prozessanforderungen 1. Projektanforderungen, Ziele und Einschränkungen Zielgruppen, Übersetzungen Rechtliche Anforderungen, Barrierefreiheit Projektplanung Zeit, Personal, Tätigkeiten, Tools 2. Analyse und Konzept Analyse der Zielgruppen, Tätigkeiten, Infobedarf Konzept für Dokumentationsarten und Medien Style Guide für Sprache, Stil, Abbildungen 50

41 ISO/IEC Prozessanforderungen 3. Dokumentationserstellung und Bewertung Erstellung gemäß Konzept, Style Guide und Projektplan Prüfungen, z. B. Korrekturlesen, Funktionstests, benutzerorientierte Evaluationen Terminologie mehrsprachig freigeben, dann Übersetzung 4. Produktion, Verteilung 5. Aktualisierung der Bausteine, Wartung, Archivierung 51

42 ISO/IEC Funktionale Anforderungen Struktur Weitgehend wie IEEE 1063 Umfang eines Topics (beim Öffnen ohne Scrollen) Inhalt Instruktionale Inhalte Informative Inhalte wie Konzepte oder technische Angaben Aufgabenorientierte Handlungsanleitungen Beschreibende Inhalte Layout Kontextsensitiv, Referenzbeschreibungen, zum Nachschlagen Print oder Online Lesbarkeit Schriften, Schriftgrößen, Auszeichnungen Formate für Sicherheitshinweise, Anleitungen, Listen, Tabellen, Orientierungshilfen Farben (max 2-3 zur Hervorhebung von Objekten) 52

43 ISO/IEC Anhänge A: Inhalte eines Style Guide Schreibstil Sprache Rechtschreibung Grammatik B: Schreistil C: Übersetzungsgerechter Schreibstil und Terminologie D: Gestaltung von gedruckter Information E: Checklisten Gedruckte Handbücher Online-Hilfen F: Checkliste zum Dokumentationsprozess G: Checkliste zu Dokumentationsprodukten 53

44 ISO/IEC Literaturangaben Barker, T.T. (2002): Writing Software Documentation: A Task -Oriented Approach, 2nd ed. New York. Nielsen J./Loranger H. (2006): Prioritizing Web Usability. Indianapolis: New Riders Press. Barnum, C. M. (2001): Usability Testing and Research. Wheildon, C. (2005): Type & Layout: Are You Communicating or Just Making Pretty Shapes? 2nd ed. Mentone, Australia: The Worsley Press. 54

45 Aspekte zur Usability von Online-Hilfen

46 Methoden der Usability-Evaluation Expertenorientierte Bewertung Reviews nach Normen, Standards, Leitlinien, Heuristiken und Problemtypologien Benutzerorientierte Methoden Offline-Verfahren (meinungsbasiert) - Interview - Fragebogen - Wording-Test, Card-Sorting - Plus-Minus-Methode - Erfahrungsbericht - Retrospektives Kommentieren des Blickverlaufes Online-Verfahren Usability-Testing (verhaltensbasiert) Quantitativ (nur Aufzeichnung) - Video - Logging - Klickanalyse - Eyetracking Qualitativ (mit Verbalisierung) - Lautes Denken - Dialogtechnik 56 Prof. Dr. Gertrud Grünwied 56

47 Vergleich 57 Prof. Dr. Gertrud Grünwied 57

48 Tekom Quali-Assistent Online-Hilfen Online-Qualität Definitionen Primärassistenz Sekundärassistenz Inhalt Struktur Zugriff Gestaltung Glossar 58 Prof. Dr. Gertrud Grünwied 58

49 Plus-Minus-Methode 59 Prof. Dr. Gertrud Grünwied 59

50 Eyetracking Blickverlaufs-Messungen Quantitative Methode (Wie lange hat die Testperson wohin geblickt, in welcher Reihenfolge laufen die Blickpunkte ab?) Kombinierbar mit Anschluss-Interview 60

51 Studiendesign Material Aufgaben Testpersonen Testablauf Technik Webbasierte Online-Hilfe des Bildbearbeitungs- Programmes Google Picasa. Aufruf: Was ist Picasa? Wie entferne ich den Roten-Augen-Effekt? Warum druckt mein Drucker die Bilder nicht? Drei Testpersonen mit Erfahrung in Bildbearbeitungs-Software, die jedoch keine fortgeschrittenen Anwender in Picasa sind. Jede Testperson bearbeitet die drei Aufgaben direkt hintereinander und jeweils in der gleichen Reihenfolge. Aufzeichnung der Blickbewegungen der Test- Ppersonen mit dem Eye Tracker Tobii

52 Blickpfad auf der Inhaltsseite einer Online-Hilfe Blickpunkt (Fixation) Teil des Blickpfades Mausklick (rotes Kreuz) 62

53 Ergebnisse 63

54 BEZUGSQUELLEN FÜR NORMEN IEEE-Standards: ISO-Standards: Beuth Verlag, Auslandsnormen, auch zum Download (mybeuth) IEEE: Germany, Austria, Switzerland and Eastern Europe, Global Information Center Fraunhoferstr. 22, Planegg, Tel. (089) Firma ILI, München, Tel. (089)