Single responsibility principle – Nur ein Verantwortlicher.
clean-code-developer

Das Prinzip SRP verwenden wir beim Dokumentieren anders als beim Programmieren. Wir verwenden das Prinzip im wörtlichen Sinne und legen für jeden Baustein im Wiki verantwortliche Rollen fest, die Inhalte im Wiki erstellen und pflegen.

  • Die Systembeschreibung pflegen Stakeholder, Business-Analysten  und Software-Experten.
  • Das Benutzerhandbuch pflegen die Business-Analysten oder technische Redakteure, unterstützt von ausgewählten Nutzern.
  • Das Betriebshandbuch pflegen Software-Experten und Entwickler zusammen mit den Verantwortlichen der Betriebsorganisation.
  • Die Architekturdefinition pflegen Software-Experten und Entwickler.

Innerhalb dieser großen Bereiche der Produktdokumentation werden Verantwortliche für den Inhalt jeder Seite im Wiki eindeutig bestimmt. Eine Seite im Wiki hat immer genau einen Autor, bis der Inhalt “fertig” ist – natürlich gemäß einer vom Team verabschiedeten Definition von “Fertig”.

Für die Veröffentlichung einer vollständigen Dokumentation gibt es die Rolle des Gärtners. Er ist verantwortlich für den Betrieb des Wiki, verwaltet die Nutzer, vergibt Rollen und Rechte. Als Gärtner ist er gleichzeitig Coach, hilft den Autoren bei der einheitlichen Gestaltung der Inhalte.