Software-Dokumentation im agilen Umfeld. Marion Bröer, parson communication

Größe: px

Ab Seite anzeigen:

Download "Software-Dokumentation im agilen Umfeld. Marion Bröer, parson communication"

Paulina Junge
vor 8 Jahren
Abrufe

1 Software-Dokumentation im agilen Umfeld Marion Bröer, parson communication

2 parson communication Software- und Prozessdokumentation Wissensmanagement Wikis und XML-basierte Dokumentation Schulungen und E-Learnings we create knowledge 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 2

XML-basierte Dokumentation Schulungen und E-Learnings

3 Agenda Wie funktioniert agile Softwareentwicklung/Scrum? Dokumentation im agilen Kontext Herausforderungen Empfehlungen Fazit 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 3

4 Agenda Wie funktioniert agile Softwareentwicklung/Scrum? Dokumentation im agilen Kontext Herausforderungen Empfehlungen Fazit 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 4

5 Wie funktioniert agile Softwareentwicklung? Ursprung: Agile Alliance, ab 2001 Ergebnis: Agile Manifesto Individuals and interactions over processes and tools Working software over comprehensive documentation Customer collaboration over contract negotiation Responding to change over following a plan 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 5

over processes and tools Working software over comprehensive documentation Customer

6 Grundprinzipien agiler Entwicklung Inkrementelle Entwicklung Anforderungen Entwickeln Testen Feedback Entwickeln Testen Feedback Entwickeln Testen Feedback Entwickeln Testen Feedback Fortschritt = funktionierende Software Enge Kooperation/Kommunikation > Team Grobspezifikation Feinspezifikation Selbstorganisation und Eigenverantwortung Transparenz Überprüfung & Anpassung Wasserfallmodell Entwurf Realisierung Test Auslieferung Scrum > eine von verschiedenen agilen Methoden 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 6

Grobspezifikation Feinspezifikation Selbstorganisation und Eigenverantwortung Transparenz Überprüfung & Anpassung Wasserfallmodell

7 Scrum Wichtige Rollen Product Owner Anwalt des Kunden ScrumMaster Coach und Unterstützer Gemeinsam zum Ziel 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 7

8 Scrum Prozess Daily Scrum User Storys Product Backlog As a user, I want. As a user, I want. As a user, I want. As a user, I want. Sprint Sprint Planning Sprint Review (Demo) Retrospective Product increment 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 8

As a user, Sprint Sprint Planning Sprint Review (Demo)

9 Agenda Wie funktioniert agile Softwareentwicklung/Scrum? Dokumentation im agilen Kontext Herausforderungen Empfehlungen Fazit 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 9

10 Dokumentation im agilen Kontext Working software over comprehensive documentation Arten von Dokumentation Qualität vor Quantität Kommunikation vor Dokumentation 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 10

Qualität vor Quantität Kommunikation vor Dokumentation

11 Agenda Wie funktioniert agile Softwareentwicklung/Scrum? Dokumentation im agilen Kontext Herausforderungen Empfehlungen Fazit 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 11

12 Herausforderungen Keine Feinspezifikation, wie kommen die Redakteure an die Informationen? Backlog > Anforderungen aus Nutzersicht Teammeetings für Detailinformationen, Rückfragen Interviews mit Entwicklern, Product Ownern, Marketing Sprint Reviews (Demos) zeigen Funktionsweise Doc-Tasks: Entwickler schreiben Dokumentation für Redakteure Usability-Tests: Redakteure als Beobachter oder Testanwender Wann ist der richtige Zeitpunkt, um mit dem Dokumentieren zu beginnen? Spannungsfeld Märchen erzählen vs. spät dokumentieren 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 12

Sprint Reviews (Demos) zeigen Funktionsweise Doc-Tasks: Entwickler schreiben Dokumentation für Redakteure Usability-Tests: Redakteure als

13 Herausforderungen Wie kann die Produktdokumentation möglichst zeitnah fertig sein? Definition of Done: Dokumentation als fester Bestandteil > pro User Story eine Dokumentationsaufgabe Dokumentation ggf. einen Sprint nach hinten versetzen Für Dokumentationsinkremente größere Intervalle als für Sprints wählen Infrastruktur optimieren > XML sinnvoll Publishing automatisieren 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 13

14 Herausforderungen Sollen die Technischen Redakteure als feste Teammitglieder in Scrum-Teams aufgenommen werden? Beide Seiten profitieren Redakteure holen sich Informationen im Team, haben Ansprechpartner für Rückfragen, fachliche Reviews Team profitiert von der Nutzerbrille der Redakteure, ihren sprachlichen Fähigkeiten und Feedback zur Usability Bewusstsein für die Notwendigkeit der Dokumentation und Akzeptanz der Redakteure verbessern sich 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 14

Team profitiert von der Nutzerbrille der Redakteure, ihren sprachlichen Fähigkeiten und Feedback zur Usability Bewusstsein für

15 Herausforderungen Was ist mit Übersetzungen? Übersetzung von Modulen frühzeitig beginnen Übersetzung vollständig ausgliedern > zum Nichtbestandteil des agilen Projekts erklären 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 15

vollständig ausgliedern > zum Nichtbestandteil des agilen

16 Herausforderungen Wann ist es Zeit zu gehen oder: An wie vielen Meetings sollen die Redakteure teilnehmen? Dilemma: Ein Redakteure > mehrere Scrum-Teams > viele Meetings Redakteure haben neben dem entwicklungsbegleitenden Schreiben weitere Aufgaben Redakteure müssen priorisieren Teams müssen ggf. Dokumentationsaufwände übernehmen, z.b. Vorab- Dokumentation für die Redakteure schreiben 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 16

entwicklungsbegleitenden Schreiben weitere Aufgaben Redakteure müssen priorisieren Teams müssen ggf.

17 Herausforderungen Ist das Redaktionsteam für sich eigentlich auch ein Scrum-Team? Scrum-Teams vs. Redaktionsteam: Vertikale Teams vs. horizontale Teams Dokumentationsaufwände sind häufig seriell, nicht komplex Redaktionsteam muss nicht vollständig agil arbeiten, aber profitiert von agilen Vorgehensweisen > z.b. Retrospective, ScrumMaster 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 17

horizontale Teams Dokumentationsaufwände sind häufig seriell, nicht komplex Redaktionsteam muss

18 Herausforderungen Wie kann man die Doku-Prozesse transparent machen? Einbinden der Aufwände in das Projekttool der Entwickler, z.b. Jira Eigene User Storys anlegen für übergreifende Aufgaben, z.b. Publishing- Aufwände, Forschungsaufgaben Pflege eines eigenen physischen/virtuellen Taskboards Im Sprint-Review Teile der Dokumentation zeigen (besonders bei Neuentwicklungen im Dokumentationsteam) 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 18

b. Publishing- Aufwände, Forschungsaufgaben Pflege eines eigenen physischen/virtuellen Taskboards Im

19 Agenda Wie funktioniert agile Softwareentwicklung/Scrum? Dokumentation im agilen Kontext Herausforderungen Empfehlungen Fazit 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 19

20 Empfehlungen für eine agile Doku-Infrastruktur Topic-basiertes Schreiben > User Storys als Basis für Topics Modularisieren, Wiederverwendung ermöglichen Trennung von Layout + Inhalt: XML, z.b. Dita Automatisierung > Reduzierung der Publishing-Aufwände Versionskontrolle und automatische Builds Minimalistisches Schreiben, regelbasiertes Schreiben > Erhöhung von Konsistenz und Qualität Relevanz > zielgruppengerecht, geeignete Ausgabeformate 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 20

Dita Automatisierung > Reduzierung der Publishing-Aufwände Versionskontrolle und automatische Builds Minimalistisches

21 Stärken nutzen Redakteur = Kommunikationsexperte + Anwalt der Nutzer > ScrumMaster oder Product Owner? Redakteure = Ersttester > Usability-Feedback für Teams Redakteure = Sprachbegabt > Benennung von Bedienungselementen, Schreiben von User Storys 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 21

22 Agenda Wie funktioniert agile Softwareentwicklung/Scrum? Auswirkungen auf die Dokumentation Herausforderungen Empfehlungen Fazit 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 22

23 Fazit Technische Redaktion in agilen Umgebungen erfordert ein hohes Maß an Kommunikation und Präsenz, gleichzeitig werden die Redakteure als wichtige Teammitglieder wahrgenommen und anerkannt Ganz oder gar nicht: Scrum funktioniert am besten, wenn sich die ganze Organisation darauf einlässt Fragen? 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 23

24 Referenzen Rüping, Andreas (2013): Dokumentation in agilen Projekten Koschek, Holger (2009): Geschichten vom Scrum: Von Sprints, Retrospektiven und agilen Werten ( Röpfstorff, Sven; Wiechmann, Robert (2013): Scrum in der Praxis: Erfahrungen, Problemfelder und Erfolgsfaktoren ( LinkedIn: Agile Technical Writers Karteikarten und Bierdeckel. User Stories für Dokumentation und Entwicklung Grafiken: fotolia.com, Microsoft Office Vielen Dank! Marion Bröer 15. Oktober 2013 Software-Dokumentation im agilen Umfeld 24

25 Marion Bröer Technical Writer parson communication Chrysanderstr. 69A Hamburg +49 (0)

Ähnliche Dokumente

Einführung in das Scrum Framework & welche 10 Praktiken helfen, Scrum wirklich gut zu machen

Einführung in das Scrum Framework & welche 10 Praktiken helfen, Scrum wirklich gut zu machen Wer bin ich Kurse und Vorträge mit Jeff Sutherland und Ken Schwaber Verschiedene Kurse der Scrum.org Professional