Wozu dient dieser Bereich?

Zur zentralen Bereitstellung der gesamten verfügbaren Dokumentation rund um die DDB - von der zugrundeliegenden IT-Systemlandschaft bis hin zur Benutzerdokumentation.

Wer ist die Zielgruppe?

Product Owner (PO), Benutzer, Administratoren, Entwickler - kurzum alle, die ein Informationsbedürfnis bezüglich der IT-Systeme und -Anwendungen der DDB haben. Auch Autoren von Dokumentationen sind angesprochen. Neue Dokumentationen oder Anpassungen von vorhandenen Dokumenten - all das passiert hier in diesem Bereich.

Wie finde ich die für mich passende Dokumentation?

Benutzerdokumentationen für Anwender gibt es unter "Benutzerdokumentationen". Einen Überblick über Systemzusammenhänge und Datenflüsse liefern die Grafiken unter "Auf einen Blick". Sie sind der ideale Einstieg in die DDB-Systemwelt. Für alle, die mehr wissen wollen ist der Bereich "Dokumentationen für Entwickler und Power-User" interessant. Und wenn es "ans Eingemachte" geht, also z.B. um Fragen rund um die Installation und Konfiguration von Anwendungen, ist das FIZ-Bitbucket die Quelle der Wahl (https://dev.fiz-karlsruhe.de/stash/projects/DDB). 

Was muss ich beachten, wenn ich selbst Dokumentationen erstelle oder pflege?

Das Erstellen und Aktualisieren von Dokumentationen nimmt Zeit in Anspruch - so pragmatisch man es auch angehen lässt. Um dies für alle sichtbar zu machen, hat diese Aufgabe immer ein eigenes JIRA-Ticket verdient.

Für bereits bestehende Software ohne Dokumentation ("Altlast") gilt für die Ersterstellung: Bitte beim Anlegen des JIRA-Tickets das Label "DDBDokumentation" nicht vergessen, damit alle Dokumentationsaufgaben schnell und einfach gefunden werden können. Details zum Vorgehen finden sich hier.

Für neue Features, die einer bestehenden Software mit bereits vorliegender Dokumentation hinzugefügt wurden, bitte beachten: Das Vorhandensein einer ausreichenden Dokumentation ist Bestandteil der Definition of Done. Bitte daher immer auch ein Dokumentationsticket als Subtask zu jedem User-Story-Ticket anlegen und auf das Einpflegen der Änderungen in die bestehende Dokumentation achten.

Sonstige Regeln zur Erstellung von Dokumentationen sind in den "Leitlinien für die DDB-Dokumentation" zusammengefasst.

Zur Rolle der Product Owner

Die POs sind für das Vorhandensein einer ausreichenden Dokumentation für "ihr" Softwareprodukt verantwortlich, d. h. sie müssen aktiv werden, wenn dieser Produktbestandteil im Rahmen eines Projekts/Sprints nicht geliefert wird. Denn: Die Dokumentation ist Bestandteil der Definition of Done (DoD)! Im Rahmen der Projekt-/Sprintplanungen ist es daher wichtig, jeweils die Erstellung einer angemessenen Dokumentation einzuplanen und die notwendige Zeit hierfür vorzusehen. 

Weiterhin stellen die POs sicher, dass die Qualität der gelieferten Dokumentation angemessen ist. Können Review und Abnahme aus welchen Gründen auch immer nicht selbst geleistet werden, muss auch hierfür eine geeignete Person eingeplant werden.

Wen kann ich bei Fragen ansprechen?

Wir, die Dokumentationsbeauftragten Stephan Bartholmei, Sylvia Kullmann und Kai Tröger, haben gerne ein offenes Ohr bei allen Fragen und Anregungen rund um diesen Bereich oder DDB-Dokumentationen.