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?
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?
Durch einen "Spaziergang" durch diesen Bereich. Oder über die Suche.
Inhaltlich gilt: 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 (nicht von diesem Bereich aus errreichbar; Kontakt über FIZ Karlsruhe).
Was muss ich beachten, wenn ich selbst Dokumentationen erstelle oder pflege?
Wichtige Regeln zur Erstellung von Dokumentationen sind in den "Leitlinien für die DDB-Dokumentation" zusammengefasst.
Für "Dokumentationen für Entwickler und Power-User" gilt: ein "sachverständiger Dritter" muss mit Hilfe der Dokumentation in angemessener Zeit in der Lage sein, die Funktionsweise einer Softwarekomponente verstehen und diese weiterentwickeln zu können.
Denk ich an DDB-Dokumentation...
...denk ich daran, im Rahmen von eigenen Projekten immer ausreichend Zeit für die Erstellung von Dokumentationen einzuplanen. Alle Entwickler und wir sagen bereits vorab "Danke !".
Dieser Bereich ist neu und noch alles andere als perfekt. Ihn nicht perfekt, aber richtig gut zu machen, das ist Zielsetzung des Projekts "DDB-Dokumentation". Vorangetrieben wird es gemeinsam von DDB und FIZ Karlsruhe.
Die Erstellung qualitätsvoller Dokumentationen stellt eine Herausforderung dar. Notwendig sind u. a. belastbares Wissen um Zusammenhänge, die Fähigkeit, das Wichtige vom Unwichtigen zu trennen, Augenmaß, Geduld, Disziplin, Durchhaltevermögen, aber auch unbedingt ausreichend Zeit.
Wir werden nicht mit schnellen Erfolgen glänzen können, dafür aber umso mehr mit kontinuierlichen Verbesserungen an der vorhandenen DDB-Dokumentation!
Der Buchstabe D, Blatt aus der Folge "Nova Alphati Effictio Historiis", wurde bereitgestellt von unserem Datengeber MKG Hamburg.