Dokumentationen - Entwicklerhandbuch

Nutzen eines Entwicklerhandbuches

»

Autorenunabhängige Weiterentwicklung möglich

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)

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