10 Things - Collaborative Documentation

Collaborative Documentation: Mit just enough zu mehr Nachhaltigkeit

Rückblick zu "10 Things"-Vortrag

Sinnvolle und richtige Dokumentation ist das Grundgerüst von jedem IT-Projekt. Doch wie viel Dokumentation ist notwendig?

Rückblick zur vierten Veranstaltung der Reihe "10 things I wished they'd told me!" im Jahr 2016

Vinzenz Preiss, Experte für Software Test und Requirements Engineering, beendete die Veranstaltungsreihe "10 things I wished they'd told me!" 2016 mit einem spannenden Vortrag zum Thema Collaborative Documentation und begeisterte die Teilnehmer mit 10 praxisnahen Tipps.

Sinnvolle und richtige Dokumentation ist das Grundgerüst von jedem IT-Projekt. Doch wie viel Dokumentation ist notwendig?

Ausgangspunkt für jede Dokumentation sollten Überlegungen zum Nutzen für die Zielgruppe sein. Nur wenn das Dokument das Problem der Zielgruppe erfüllt, wird es auch angenommen.

Machen Sie sich auch Gedanken darüber, in welchem Reifegrad sich Ihr Dokument entlang des Produktlebenszyklus befindet. Entlang dieses Prozesses reift das Produkt und verändert sich, bis es schließlich seinen definierten Zweck erfüllen kann. Unterstützen Sie diesen Prozess durch frühe Stichworte und validieren Sie inhaltliche Eckpunkte. Formulieren Sie aber erst möglichst spät aus. Je später Sie Ihre Beschreibung in seine finale Form bringen, desto geringer ist die Gefahr von unerwünschtem Änderungsaufwand.

Das inhaltlich beste Dokument erfüllt seinen Zweck jedoch nicht, wenn es nicht auch ansprechend gestaltet ist. Auch etwas Niedergeschriebenes führt zu User Experience. Sorgen Sie deshalb für ansprechendes Dokumenten-Design. Wählen Sie eine Darstellung, bei der Infos durch die natürliche Auffassungsgabe des Menschen direkter transportiert werden können.

Doch nicht immer sind geschriebene Dokumente die sinnvollste Lösung. Nichts ist effektiver als das persönliche Gespräch. Info, die nur von kurzer Relevanz ist oder Verständnis, das einmal geschaffen wurde, muss nicht niedergeschrieben werden.

Folgende "10 things" erarbeitete Vinzenz Preiss aus seiner Erfahrung:

  1. Jedes Dokument muss messbar den Nutzen einer Zielgruppe erfüllen
  2. Starten Sie Ihr Dokument früh, detaillieren Sie es jedoch spät
  3. Dokumentieren Sie wiederverwendbar
  4. Übersichtlichkeit zählt vor Details
  5. Das persönliche Gespräch geht vor
  6. Nutzen Sie Blackboxing & Perspektivenwechsel
  7. Beachten Sie Vorschriften
  8. Gestalten Sie jedes Dokument ansprechend
  9. Setzen Sie auf Documentation Mapping
  10. Nutzen Sie Tools und Automatisierung

 

Hier finden Sie eine übersichtliche Zusammenfassung der Tipps zum Thema Collaborative Documentation.

Hier geht's zum Download der Vortragsfolien

Vortragender
Vortragender Josef Falk

Josef Falk
Principal Consultant
IT Analyse

Veranstaltungskalender
< April 2024 >
Mo Di Mi Do Fr Sa So
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30          

Zurück

Zum Seitenanfang navigieren