Trends in der Softwaredokumentation

Transkript

1 Trends in der Softwaredokumentation Prof. Sissi Closs Montag,, 11. Oktober 2010

2 Community, Connectivity, Collaboration

3 NextGen Softwaredoku Training 1. Software wird immer flexibler. 2. GUI Bedienung braucht keine Erklärung. Entwicklung Marketing 3. Es gibt noch keine etablierten Strukturen für die benötigten Inhalte (Abläufe,...). Technische Redakteure Zulieferer Kunden

4 Ziel: vernetzte Informationsbausteine

5 Wie erreichen wir dieses Ziel? Vorbereitung auf unterschiedlichen Ebenen: Methodisch Technisch Kulturell

6 -basierte Strukturierung Strukturierte Ansätze: XML standards (DITA, S1000D) Unstrukturierte Ansätze: -Strukturen in offenen, flexiblen Umgebungen (Wikis).

7 Prinzip 1: Inhalte in Bausteine aufteilen

8 Beispiel s

9 Aus Bausteinen flexibel Dokumente zusammenstellen Maps Dokumente s

10 Vorteile topic-basierter Welten Es ist leichter, 1 zu erstellen, wiederzuverwenden, zu aktualisieren als ein komplettes Dokument. Experten können ihre Beiträge gleichzeitig austauschen. Reaktionszeiten werden schneller: Sobald einzelne s erstellt sind, können sie überprüft/überarbeitet werden. Aktualisierte Bausteine können sofort publiziert werden. Bausteine können bereits übersetzt werden, wenn das restliche Dokument noch in Bearbeitung ist.

11 Problem: Tausende von s

12 Prinzip 2: Kategorien definieren

13 Wie finden wir passende -Typen Typen? 1. Auf bekannten aufsetzen Reference Definition Task Error message 2. Methoden nutzen: Klassenkonzepttechnik (Sissi Closs)

14 Prinzip 3: Standardisierung

15 Technik: DITA Standardisierte XML Architecture für Print und Online Dokumentation unterstützt topic-orientierte Strukturierung unterstützt Typisierung unterstützt Zusammenarbeit

16 Beispiel: DITA Glossareintrag Elemente für Begriff Definition des Begriffs glossentry glossterm glossdef related-links

17 Agile Verfahren Product Team Chief Product Owner Scrum Team Scrum Master Architect Scrum Team Scrum Master Product Owner Dev Info Developer Architect Quality Engineer Test Engineer Dev KM Quality Engineer Scrum Master Dev Info Developer Product Owner Architect Quality Engineer Test Engineer Scrum Team Scrum Team Scrum Master Product Owner Scrum Master Product Owner Architect Architect Dev Info Developer Quality Engineer Test Engineer Dev Info Developer Quality Engineer Test Engineer

18 Agile Verfahren Iterativer Stufenprozess durchgängig minimalistischer Ansatz flexibel Offene team-orientierte Kultur: Hohes Maß an Eigenverantwortung Austausch mit Anderen muss von jedem akzeptiert sein Beiträge der Anderen konstruktiv behandeln

19 Trends: : eingebettete Hilfe Hinweise und Beispiele direkt in der GUI Links zu Hilfe-s direkt in der GUI

20 Trends: : eingebettete Hilfe

21 Trends: proaktive Hilfe Informationen tauchen auf, ohne, dass Nutzer diese anfordern muss angepasst an Nutzer und Nutzerverhalten

22 Trends: proaktive Hilfe

23 Trends: : führende f Hilfe

24 Trends: : Nutzerbeteiligung Tagging Feedback Filterung automatische Vorschläge (genius) Inhalte zusammen erstellen

25 Trends: : Nutzerbeteiligung

26 Trends: : Nutzerbeteiligung

27 Trends: : Nutzerbeteiligung

28 Trends: Wiki-Hilfe

29 Trends: : Trennung Herstellerdoku und Wiki-Hilfe

30 Warum ein Wiki? höherer Spaßfaktor schnelle Ergebnisse passendere Verwaltungsunterstützung bessere Qualität der Inhalte

31 s mit Metadaten Mehrere Sichten- Lösung: Kategorisierung

32 Einfache Handhabung mit Vorlagen

33 Workflow (Beispiel( Confluence)

34 Trends: : Einfacher Zugang

35 So wird es gelingen topic-basierte Strukturen agile Verfahren gemeinsame Standards attraktive Zugänge

36 Wir unterstützen tzen Sie gerne