06-1_Anlage 1L_Systemdokumentation_Fachverfahren_Vers1.pdf

[Seite 1]

<Anwendungsname/IT-Gesamtsystem >

LfULG

Systemdokumentation

[IT-Fachverfahren]

(Abt. x – Referat)

Vertraulichkeit intern

Link zur cmdb < Direktlink zur cmdb einfügen>

Dokumenten- Leistungsverantwortliche/r (siehe cmdb) verantwortliche/r

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 1 von 19

[Seite 2]

<Anwendungsname/IT-Gesamtsystem >

Dokumentenhistorie

Zweck des Dokumentes

Das vorliegende Dokument beinhaltet die umfassende technische Beschreibung des IT- Fachverfahrens xx des LfULG. Es wird ergänzt durch das Betriebshandbuch, welche alle für den Betrieb relevanten Informationen enthält (Installation, Konfiguration, Aktualisierung und Fehlerbehebung).

Leserschaft

Das vorliegende Dokument richtet sich vorwiegend an A11 als auch die Fachadministratoren des entsprechenden IT-Fachverfahrens im Geschäftsbereich des Sächsischen Landesamts für Umwelt, Landwirtschaft und Geologie.

Zuständigkeiten für das Dokument

Dem Sächsischen Landesamt für Umwelt, Landwirtschaft und Geologie obliegt die Verantwortung für das vorliegende Dokument. Das Dokument wird durch den Dienstleister erstellt. Nach Abschluss der Entwicklung fällt die Verantwortung der Pflege und Fortschreibung in die A11, sofern im zugehörigen EVB-IT Servicevertrag oder anderen Vertragsformen nichts anderes vereinbart ist.

weiterführende Dokumente zum System

Betriebshandbuch als Link

Ablageordner als Link

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 2 von 19

[Seite 3]

<Anwendungsname/IT-Gesamtsystem >

Inhaltsverzeichnis

1 Einleitung ........................................................................................................................ 4 2 Systemübersicht ............................................................................................................. 5 3 Installation und Setup / Deinstallation ............................................................................. 6 4 Architektur und Design .................................................................................................... 7 5 API-/Schnittstellen-Dokumentation .................................................................................. 8 6 Installierte/Benutzte Technologie .................................................................................... 9 7 Rechte- und Rollenkonzept ............................................................................................10 8 Betrieb und Betriebssicherheit .......................................................................................11 9 Tests ..............................................................................................................................12 10 Migrationen und Migrationsplan ..................................................................................13 11 Sicherheit ...................................................................................................................14 12 Benutzung/Benutzerführung .......................................................................................15 13 Fehlersuche und Troubleshooting ...............................................................................16 14 Anhang .......................................................................................................................17 15 Versionsgeschichte .....................................................................................................18 16 Lizenz und rechtliche Hinweise ...................................................................................19

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 3 von 19

[Seite 4]

<Anwendungsname/IT-Gesamtsystem >

1 Einleitung

• Ziel der Software
• Zielgruppe
• Abhängigkeiten (Hardware/Software)
• Überblick über die Struktur der Doku

Dieser Abschnitt ist kurz zu halten und soll einen schnellen Überblick über das Verfahren geben, insbesondere für nicht im Entwicklungsprozess Beteiligte.

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 4 von 19

[Seite 5]

<Anwendungsname/IT-Gesamtsystem >

2 Systemübersicht

• Architekturdiagramm (z. B. Komponenten, Module)

• Hauptziele und Annahmen

• Verfügbare Plattformen und Umgebungen Darstellung der Einbindung des Systems in die Gesamtarchitektur, Anbindung an externe und interne Systeme und Abbildung aller manuellen und automatischen Schnittstellen. Darstellung durch mindestens eine Abbildung und eine kurze, möglichst tabellarische Beschreibung.

• fachliche und technische Kontextsicht (gemäß arc42, Kap. 3: https://docs.arc42.org/section-3/) inkl. je ein Kontextdiagramm (nach Möglichkeit mit C4- oder UML2.0-Notation, z.B. Komponentendiagramm)

• Datenflussdiagramm: nur bis auf Ebene von separat deployten Services/Komponenten des Fachverfahrens (es gibt keinen Standard hierfür; die gängig verwendeten Symbole können u.a. hier nachgesehen werden: https://de.wikipedia.org/wiki/Datenflussdiagramm) Schätzungen über die Menge und die zeitliche Verteilung des Datenverkehrs sind anzugeben.

• Verteilungssicht (vom IT-Betrieb LfULG zu erarbeiten) In welcher Umgebung läuft das System ab? Wo läuft was? Zuordnung zu Infrastrukturkomponenten

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 5 von 19

[Seite 6]

<Anwendungsname/IT-Gesamtsystem >

3 Installation und Setup / Deinstallation

Siehe Betriebshandbuch

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 6 von 19

[Seite 7]

<Anwendungsname/IT-Gesamtsystem >

4 Architektur und Design

• Komponentenbeschreibung: Diagramm in UML oder C4 (gemäß arc42 Bausteinsicht: https://docs.arc42.org/section-5/
• Laufzeitsicht (gemäß arc42, Kap. 6: https://docs.arc42.org/section-6/
• Datenmodelle (ER-Diagramme, Schemas)
• Sicherheitskonzepte (Authentifizierung, Autorisierung, Verschlüsselung)
• Fehler- und Logging-Strategie

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 7 von 19

[Seite 8]

<Anwendungsname/IT-Gesamtsystem >

5 API-/Schnittstellen-Dokumentation

• Endpunkte, Methoden, Parameter, Antworten
• Authentifizierung/Ursprünge
• Fehlercodes
• Beispielanfragen und -antworten
• Schnittstellen (APIs, Message Schemas): Es sind sowohl automatisierte als auch manuelle Schnittstellen zu beschreiben. Nicht zu vergessen sind Ex- oder Importe für Excel, Drucke, „exotische“ Ausgabeformate oder Fernwartungsschnittstellen

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 8 von 19

[Seite 9]

<Anwendungsname/IT-Gesamtsystem >

6 Installierte/Benutzte Technologie

• Programmiersprachen
• Frameworks und Bibliotheken
• Drittanbieter-Dienste
• Infrastruktur (Container, Cloud, On-Prem)
• SBOM (nicht hier aufzulisten, sondern im Format CycloneDX (zwingend) und/oder im Format SPDX (ggf. Vertrag berücksichtigen) zu übergeben)

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 9 von 19

[Seite 10]

<Anwendungsname/IT-Gesamtsystem >

7 Rechte- und Rollenkonzept

ggf. separates Dokument

• Benutzerrollen und -gruppen:

o Eine klare Definition der unterschiedlichen Benutzerrollen und -gruppen im System (z.B. Administratoren, Benutzer, Support, Gäste).

o Beschreibung der Berechtigungen und Einschränkungen jeder Rolle, einschließlich der zugewiesenen Funktionen und Datenzugriffe.

• Zuweisung von Rechten:

o Verfahren zur Zuweisung und Änderung von Benutzerrechten, einschließlich der Verantwortlichkeiten für die Vergabe.

o Regeln und Prozesse zur Änderung von Rollen, beispielsweise bei Mitarbeiterwechseln oder Funktionsänderungen.

• Rechteüberprüfung und -revision:

o Prozesse zur regelmäßigen Überprüfung und Aktualisierung der vergebenen Rechte.

o Festlegung von Mechanismen zur Sicherstellung, dass Benutzer nur die Rechte haben, die sie für ihre Aufgaben benötigen (Prinzip der minimalen Rechtevergabe).

• Verantwortlichkeiten:

o Definition der verantwortlichen Personen oder Rollen für die Genehmigung und Verwaltung von Benutzerrechten.

o Klärung der Genehmigungsprozesse und Dokumentation der jeweiligen Schritte zur Rechtevergabe.

• Zugriffskontrolle und Sicherheitsmechanismen:

o Detaillierte Beschreibung der verwendeten Zugangskontrollen (z.B. Authentifizierung, Zwei-Faktor-Authentifizierung) und der Sicherheits- maßnahmen zum Schutz vor unbefugtem Zugriff.

• Protokollierung und Überwachung von Rechteänderungen:

o Verfahren zur Protokollierung aller Änderungen an Benutzerrechten, um Transparenz und Nachvollziehbarkeit zu gewährleisten.

o Mechanismen zur Überwachung von Zugriffsversuchen und sicherheitsrelevanten Ereignissen im Zusammenhang mit Benutzerrechten.

• Notfallmanagement:

o Definition von Prozessen zur schnellen Wiederherstellung der Rechtevergabe im Falle von Sicherheitsvorfällen oder Systemfehlern.

Das Rechte-/Rollenkonzept sorgt dafür, dass der Zugriff auf das System auf autorisierte Benutzer beschränkt bleibt und die Integrität sowie die Sicherheit der Daten jederzeit gewährleistet sind.

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 10 von 19

[Seite 11]

<Anwendungsname/IT-Gesamtsystem >

8 Betrieb und Betriebssicherheit

Siehe Betriebshandbuch

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 11 von 19

[Seite 12]

<Anwendungsname/IT-Gesamtsystem >

9 Tests

• Teststrategie
• Arten von Tests (Unit, Integration, End-to-End)
• Testfälle/Voraussetzungen
• CI/CD-Pipeline

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 12 von 19

[Seite 13]

<Anwendungsname/IT-Gesamtsystem >

10 Migrationen und Migrationsplan

• Datenmigration
• API-Kompatibilität
• Breaking Changes

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 13 von 19

[Seite 14]

<Anwendungsname/IT-Gesamtsystem >

11 Sicherheit

Siehe Informationssicherheitskonzept

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 14 von 19

[Seite 15]

<Anwendungsname/IT-Gesamtsystem >

12 Benutzung/Benutzerführung

Siehe Benutzerhandbuch

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 15 von 19

[Seite 16]

<Anwendungsname/IT-Gesamtsystem >

13 Fehlersuche und Troubleshooting

• Häufige Probleme mit Lösungen
• Logs/Diagnosebefehle
• siehe auch Betriebshandbuch Kap. 5.1

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 16 von 19

[Seite 17]

<Anwendungsname/IT-Gesamtsystem >

14 Anhang

• Glossar
• Referenzen

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 17 von 19

[Seite 18]

<Anwendungsname/IT-Gesamtsystem >

15 Versionsgeschichte

• Datum, Version, Änderung/Release-Notes

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 18 von 19

[Seite 19]

<Anwendungsname/IT-Gesamtsystem >

16 Lizenz und rechtliche Hinweise

Stand: 07.05.2026 <Anwendungsname/IT-Gesamtsystem >

Version: 1.0 Seite 19 von 19