O'Reilly logo

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Dokumentation in agilen Projekten

Book Description

Prägnante und gut strukturierte Dokumente bieten eine hohe Lesbarkeit und einen schnellen Zugriff auf das darin enthaltene Wissen. Von den agilen Verfahren zur Softwareentwicklung können wir viel über eine bedarfsgerechte Dokumentation lernen, z.B. dass es sinnvoll ist, die Notwendigkeit einzelner Dokumente kritisch zu prüfen und nur solche Dokumente zu erstellen, die einen tatsächlichen, klar erkennbaren Nutzen haben. Der Leser erhält in diesem Buch konkrete Hinweise zu einer bedarfsgerechten Dokumentation – in Form von Lösungsmustern und zahlreichen Beispielen aus der Praxis.

Table of Contents

  1. Cover
  2. Titel
  3. Impressum
  4. Vorwort
  5. Danke
  6. Inhaltsverzeichnis
  7. 1 Einleitung
    1. 1.1 Motivation
    2. 1.2 Historie der agilen Entwicklung
    3. 1.3 Muster
    4. 1.4 Nutzung des Buchs
  8. 2 Einstieg in ein agiles Vorgehen
    1. 2.1 Orientierung am Leserkreis
    2. 2.2 Dokumentation langfristig relevanten Wissens
    3. 2.3 Skalierbare Dokumentation
    4. 2.4 Erkenntnisgewinn durch Dokumentation
    5. Zusammenfassung und Ausblick
  9. 3 Infrastruktur und Werkzeuge
    1. 3.1 Wenige einfache Tools
    2. 3.2 Wiki
    3. 3.3 Bedarfsgerechte Formate
    4. 3.4 Generierung unterschiedlicher Formate
    5. Zusammenfassung und Ausblick
  10. 4 Planung der Dokumentation
    1. 4.1 Lebendige Anforderungsdokumentation
    2. 4.2 Einbindung der Kunden
    3. 4.3 Planungstransparenz
    4. 4.4 Inkrementelle Dokumentation
    5. 4.5 Initiative für Fragen der Dokumentation
    6. 4.6 Dokumentenreviews
    7. Zusammenfassung und Ausblick
  11. 5 Auswahl der richtigen Inhalte
    1. 5.1 Der große Überblick
    2. 5.2 Motivation, Begründungen und Alternativen
    3. 5.3 Drehbuch
    4. 5.4 Realistische Beispiele
    5. Zusammenfassung und Ausblick
  12. 6 Gestaltung einzelner Dokumente
    1. 6.1 Klare Struktur
    2. 6.2 Richtlinien für die Leser
    3. 6.3 Maßvoller Einsatz von Diagrammen
    4. 6.4 Verbreiteter Einsatz von Tabellen
    5. 6.5 Reichhaltige Verknüpfungen
    6. 6.6 Leserfreundliches Layout
    7. Zusammenfassung und Ausblick
  13. 7 Umgang mit der Dokumentation
    1. 7.1 Aktive Verteilung
    2. 7.2 Dokumentationslandschaft
    3. 7.3 Anleitung zur Erstellung der Dokumentation
    4. 7.4 Wissensmanagement
    5. Zusammenfassung und Ausblick
  14. 8 Zusammenfassung
    1. 8.1 Stellenwert bedarfsgerechter Dokumentation
    2. 8.2 Bedarfsgerechte Dokumentation in der täglichen Praxis
  15. A.1 Kurzfassungen der einzelnen Muster
    1. Einstieg in ein agiles Vorgehen
      1. Orientierung am Leserkreis
      2. Dokumentation langfristig relevanten Wissens
      3. Skalierbare Dokumentation
      4. Erkenntnisgewinn durch Dokumentation
    2. Infrastruktur und Werkzeuge
      1. Wenige einfache Tools
      2. Wiki
      3. Bedarfsgerechte Formate
      4. Generierung unterschiedlicher Formate
    3. Planung der Dokumentation
      1. Lebendige Anforderungsdokumentation
      2. Einbindung der Kunden
      3. Planungstransparenz
      4. Inkrementelle Dokumentation
      5. Initiative für Fragen der Dokumentation
      6. Dokumentenreviews
    4. Auswahl der richtigen Inhalte
      1. Der große Überblick
      2. Motivation, Begründungen und Alternativen
      3. Drehbuch
      4. Realistische Beispiele
    5. Gestaltung einzelner Dokumente
      1. Klare Struktur
      2. Richtlinien für die Leser
      3. Maßvoller Einsatz von Diagrammen
      4. Verbreiteter Einsatz von Tabellen
      5. Reichhaltige Verknüpfungen
      6. Leserfreundliches Layout
    6. Umgang mit der Dokumentation
      1. Aktive Verteilung
      2. Dokumentationslandschaft
      3. Anleitung zur Erstellung der Dokumentation
      4. Wissensmanagement
  16. A.2 Portfolio möglicher Dokumente
    1. Projektdokumentation
    2. Prozessdokumentation
    3. Anforderungsdokumentation
    4. Systemdokumentation
      1. Produktdokumentation
  17. A.3 Glossar
    1. Agile Entwicklung
    2. Agile Methode
    3. Agile Modeling
    4. Agiles Manifest
    5. Akzeptanzkriterien
    6. Backlog
    7. Crystal
    8. DevOps
    9. Dokument
    10. Dokumentation
    11. Epic
    12. Feature-Driven Development (FDD)
    13. Hypertext
    14. Inkrement
    15. Inkrementelle Entwicklung
    16. Iteration
    17. Iterative Entwicklung
    18. Kanban
    19. Product Backlog
    20. Product Owner
    21. Retrospektive
    22. Scrum
    23. Sprint
    24. Sprint Backlog
    25. Sprint-Planung
    26. Sprint-Review
    27. Task
    28. Taskboard
    29. Team
    30. Template
    31. Use Case
    32. User Story
    33. XP (eXtreme Programming)
    34. Wiki
  18. Literatur
  19. Index