Projektarbeit-MYP/IHK_Projektdokumentation/Kundendokumentation_Anhang/README.md

IHK Kundendokumentation - Anhang Punkt 6

Projektübersicht

Projekt: MYP - Manage Your Printer
Projektzeitraum: 15.04.2025 - 20.05.2025
Prüfungsbewerber: Till Tomczak
Ausbildungsbetrieb: Mercedes-Benz AG, Technische Berufsausbildungsstätte Berlin

Generierte Dokumente

Diese Dokumentation wurde gemäß den IHK-Anforderungen für die Fachrichtung "Digitale Vernetzung" automatisch generiert und umfasst alle geforderten Dokumente für Anhang Punkt 6.

0. Inhaltsverzeichnis der Anhänge

Datei: 00_Inhaltsverzeichnis_Anhang.docx

Übersichtsdokument mit:

• Projektinformationen
• Tabellarische Auflistung aller Anhänge
• Kurzbeschreibungen der Dokumente

1. Berufsspezifika (FR Digitale Vernetzung)

Datei: 01_Berufsspezifika_FR_Digitale_Vernetzung.docx

Enthält die projektbezogenen Tätigkeiten mit Fokus auf:

• Vernetzung von Systemen (Smart-Plugs, REST-API, WebSocket)
• Prozessintegration (Automatisierung, Echtzeit-Synchronisation)
• Schnittstellenimplementierung (über 100 API-Endpunkte)
• Sicherheitsaspekte (Verschlüsselung, Authentifizierung)

2. Gesprächsprotokoll

Datei: 02_Gespraechsprotokoll.docx

Dokumentiert das initiale Projektgespräch vom 15.04.2025 mit:

• Teilnehmerliste (Ausbildungsleiter, IT-Abteilung, Werkstattleiter)
• Diskussion der technischen Anforderungen
• Klärung der Sicherheitsrichtlinien
• Ressourcenplanung und Budgetierung

3. Mess- und Prüfprotokoll

Datei: 03_Mess_und_Pruefprotokoll.docx

Umfasst technische Tests und Messungen:

• Netzwerkverbindungstests aller Komponenten
• Performance-Messungen (Ladezeiten, Response-Zeiten)
• Sicherheitsprüfungen (SQL-Injection, XSS, CSRF)
• Funktionstests aller Systemkomponenten

4. Übergabeprotokoll

Datei: 04_Uebergabeprotokoll.docx

Dokumentiert die Systemübergabe am 20.05.2025:

• Liste aller Hardware-Komponenten
• Software-Versionen und Konfigurationen
• Übergebene Dokumentation
• Zugangsdaten und Systemstatus

5. Abnahmeprotokoll

Datei: 05_Abnahmeprotokoll.docx

Bestätigt die erfolgreiche Projektabnahme:

• Prüfung aller Anforderungen
• Funktionsprüfung des Gesamtsystems
• Dokumentationsprüfung
• Abnahmeerklärung mit Unterschriften

6. Anwenderhandbuch (Auszug)

Datei: 06_Anwenderhandbuch_Auszug.docx

Enthält die wichtigsten Bedienungsanleitungen:

• Systemzugang und Anmeldung
• Schritt-für-Schritt-Anleitung zur Reservierung
• Wichtige Hinweise zur Nutzung
• Häufig gestellte Fragen (FAQ)

7. Prozessdarstellung

Datei: 07_Prozessdarstellung.docx

Beschreibt den digitalisierten Reservierungsprozess:

• Detaillierte Prozessschritte mit Akteuren
• Entscheidungspunkte im Ablauf
• Automatisierte Prozesse und Trigger
• Fehlerbehandlungsmechanismen

8. Netzwerkplan

Datei: 08_Netzwerkplan.docx

Dokumentiert die Netzwerkinfrastruktur:

• IP-Adressplan aller Komponenten
• Netzwerktopologie (Stern-Topologie)
• Sicherheitszonen (DMZ, IoT-Segment, Client-Netzwerk)
• Firewall-Regeln und Monitoring

Technische Details

Systemarchitektur

• Server: Raspberry Pi 5 (8GB RAM, 128GB SSD)
• Smart-Plugs: 6x TP-Link Tapo P110
• Netzwerk: Isoliertes Segment 192.168.0.0/24
• Software: Flask Backend, Next.js Frontend

Sicherheitsmerkmale

• Offline-Funktionalität (keine Internetverbindung erforderlich)
• SSL/TLS-Verschlüsselung
• bcrypt-basiertes Password-Hashing
• Rate-Limiting gegen Brute-Force

Automatisierung

Das Python-Skript generate_ihk_documents.py generiert alle Dokumente automatisch mit:

• Korrekter Formatierung nach DIN 5008
• Professionellem Layout
• Plausiblen und konsistenten Daten
• IHK-konformen Inhalten

Verwendung

1. Python 3.x installieren
2. pip install python-docx ausführen
3. python generate_ihk_documents.py ausführen
4. Alle Dokumente werden im aktuellen Verzeichnis erstellt

Optional: Für das Inhaltsverzeichnis zusätzlich python create_index.py ausführen

Hinweise

• Die Dokumente enthalten realistische Beispieldaten basierend auf der Projektdokumentation
• Alle Zeitangaben und technischen Details sind konsistent
• Die Formatierung entspricht professionellen Standards
• Bei Bedarf können die Dokumente manuell angepasst werden

Visualisierungen

Zusätzlich zu den Word-Dokumenten wurden folgende Diagramme erstellt:

• Netzwerkdiagramm: Zeigt die vollständige Netzwerkarchitektur mit allen Komponenten
• Prozessablaufdiagramm: Visualisiert den Reservierungsprozess als Flussdiagramm

Diese können bei Bedarf in die Dokumente eingefügt oder separat verwendet werden.