Dokumentationen - Entwicklerhandbuch

Das Entwicklerhandbuch stellt ein zentrales Element in der Dokumentationslandschaft von Softwareprojekten dar. Es dient als umfassende Informationsquelle, die Entwicklern einen detaillierten Einblick in die Anwendung, deren technische Spezifikationen und die Einbindung in die Systemlandschaft bietet.

Basierend auf den DV-Umsetzungskonzepten, die im Rahmen von Projekten entwickelt werden, beschreibt das Entwicklerhandbuch die Anwendung aus der Perspektive des Entwicklers. Es legt besonderen Wert auf die Darstellung der technischen Besonderheiten der Anwendung sowie deren Integration in die bestehende IT-Infrastruktur.

Die kontinuierliche Aktualisierung und Autorenunabhängigkeit der Dokumentation sind entscheidend, um eine nachhaltige Weiterentwicklung und Wartung der Software zu ermöglichen, ohne von einzelnen Entwicklern abhängig zu sein.

Nutzen eines Entwicklerhandbuches

Autorenunabhängige Weiterentwicklung
Durch eine klare, umfassende Dokumentation wird sichergestellt, dass die Anwendung auch unabhängig vom ursprünglichen Entwicklerteam weiterentwickelt werden kann.
Vermeidung von Wissensmonopolen
Die Dokumentation dient der Wissensverteilung und verhindert, dass essentielles Know-how nur bei einzelnen Personen liegt.
Effizienzsteigerung
Durch die Bereitstellung relevanter Informationen können Entwicklungs- und Wartungszeiten reduziert werden.

Nutzen eines Entwicklerhandbuches
»	Autorenunabhängige Weiterentwicklung möglich

Struktur und Inhalte eines Entwicklerhandbuches

Beschreibung der Anwendung

Anwendungssteckbrief
Eine kompakte Übersicht über die Applikation, einschließlich Name, Ziel und Zweck sowie unterstützte Geschäftsprozesse.

Entwicklungsrichtlinien

Programmierstandards
Verweise auf bestehende Programmierstandards und Entwicklungsrichtlinien, die innerhalb der Anwendung genutzt werden.

Struktur der Anwendung

Architektonischer Aufbau
Darstellung der Anwendungsarchitektur und des Kontextdiagramms, um die Einordnung in die Systemlandschaft zu verdeutlichen.
Daten- und Funktionsmodell
Beschreibung des Datenmodells bzw. der Datenbankstruktur sowie des Funktionsmodells, inklusive Anwendungsfällen und Use Case Diagrammen.

Schnittstellen und Berechtigungskonzept

Integration
Detaillierte Beschreibung der Schnittstellen zu anderen Systemen und Anwendungen sowie des Berechtigungskonzepts.

Programm- und Job-Abläufe

Implementierungsdetails
Ausführungen zu spezifischen Programminhalten und Job-Abläufen, eventuell ergänzt durch relevante Code-Ausschnitte.

Maschinelle Kontrollmechanismen

Überwachung und Kontrolle
Erläuterung implementierter Kontrollmechanismen zur Sicherstellung der Funktionsfähigkeit und Integrität der Anwendung

Konfiguration und Betrieb

Betriebshandbuch und SLAs
Verweise auf das Betriebshandbuch und Service Level Vereinbarungen, die für den Betrieb der Anwendung relevant sind.

Ein Entwicklerhandbuch dient nicht nur als technische Dokumentation für die unmittelbare Anwendungsentwicklung, sondern bildet auch eine wichtige Grundlage für die Qualitätssicherung, das Projektmanagement und die Compliance. Durch die Bereitstellung einer detaillierten und zugänglichen Dokumentation wird ein Beitrag zur Sicherstellung der langfristigen Nutzbarkeit und Wartbarkeit der Software geleistet. Die Einbindung von Kommentaren im Code und die Bereitstellung von Installationsanweisungen innerhalb des Entwicklerhandbuches erhöhen zusätzlich die Transparenz und Nachvollziehbarkeit.

Beispiel:

Beschreibung der Anwendung

Name der Applikation

Ziel und Zweck der Anwendung (Welche Prozesse werden wie inhaltlich unterstützt?)

Übersicht

Anwendungssteckbrief

Entwicklungsrichtlinien (ggf. Verweis auf bestehende und genutzte Programmierstandards)

Struktur der Anwendung

Kontextdiagramm

Architekturdiagramm

Aufbau und Ablauf der Anwendung

Datenmodell / Datenbankmodell

Funktionsmodell / Anwendungsfälle (Anwendungsfallmodell)/ Use Case Diagramme

GUI/ Benutzeroberfläche (inkl. Datenfluss, System- und Fehlermeldungen, Plausibilitätsprüfungen)

List- oder Report-Ausgaben

Berechtigungskonzept

Schnittstellen

Programme

Beschreibung der Programminhalte (Customizing-Einstellungen), ggf. inkl. Code-Ausschnitte

Job-Abläufe

Beschreibung der Job-Inhalte, ggf. inkl. Code-Ausschnitte

Maschinelle Kontrollmechanismen

Beschreibung der implementierten Kontrollmechanismen

Konfiguration

Verweis auf das Betriebshandbuch, Service Level Vereinbarungen

Dokumentenstruktur Jobdokumentation	Inhalte
Allgemeine Jobsteuerungsinformationen	z.B. System, Mandant, Applikationsserver, Masterplan, Jobcluster, Jobplan, Jobname oder Prozesskettenname, Jobkettenbeschreibung oder Prozesskettenbeschreibung, Jobklasse, Job Priorität, Job Ersteller
Applikationsspezifische Jobsteuerungsinformationen	z.B. Repository, Integration, Ordner, Workflow
Startbedingungen	z.B. geplante Startzeit, Rhythmus, Abhängigkeiten, erwartete Laufzeit pro Lauf:
Ansprechpartner	z.B. Abteilung, Name, Funktion, Kontaktdaten
Jobbeschreibung	z.B. Inhalt des Jobs, Jobabbruch (Einschätzung möglicher Jobabbrüche, Vorgehen, Kommunikationswege)