Files
docu_build/doc/kapitelstruktur.md
T
2026-09-22 17:10:15 +02:00

286 lines
12 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Kapitelstruktur - Mapping Fortna-Referenz
Abgeleitet aus dem realen Projekt Fortna (doc/Fortna.txt, 374 Dateien, 123 Ordner).
Angepasst auf deutsche Ordnernamen, Sprachtrennung auf Top-Level.
## Kapitel-Uebersicht
| Nr | Ordner | Inhalt | Fortna-Quelle |
|----|--------|--------|---------------|
| 00 | `00_inhaltsverzeichnis` | Inhaltsverzeichnis, Dokumentennotizen | 00_CONTENTS_NOTES |
| 01 | `01_zertifikate` | CE/UKCA-Konformitaetserklaerungen, Konfigurationsbeschreibung, Einbauerklaerungen, Komponenten-DoCs | 01_CERTIFICATES |
| 02 | `02_sicherheit` | Allgemeine Sicherheit, Normen, Risikobewertung | (neu, teilweise 04_TECHNICAL_DOC) |
| 03 | `03_anlagenbeschreibung` | Maschinenmodule (via meta.yaml eingefuegt) | (neu) |
| 04 | `04_betrieb` | Betriebsanleitung | 02_INSTRUCTIONS (Betriebsanleitung) |
| 05 | `05_wartung` | Wartungsanleitung, Schmierplan | 02_INSTRUCTIONS (Wartungsanleitung) |
| 06 | `06_steuerung` | Funktionsbeschreibungen Steuerung | 02_INSTRUCTIONS (Funktion_Steuerung_*) |
| 07 | `07_ersatzteile` | Ersatzteillisten | 03_SPARE_PARTS |
| 08 | `08_lieferantendoku` | Lieferantendokumentation | 05_SUPPLIER_DOC |
| 09 | `09_technische_unterlagen` | Layouts, Schaltplaene, Not-/Bereichsstopp | 04_TECHNICAL_DOC |
| 10 | `10_anhang` | Pruefberichte, Abnahmeprotokolle | 04_TECHNICAL_DOC/REPORTS |
## Detailstruktur
### 00_inhaltsverzeichnis
Wird vom Build-Prozess generiert. Enthaelt Gesamtinhaltsverzeichnis und ggf. Dokumentennotizen/Revisionshistorie.
### 01_zertifikate
```text
01_zertifikate/
konformitaetserklaerung/ # CE-/UKCA-Erklaerungen (Fortna: 01_SCHOENENBERGER)
konfigurationsbeschreibung/ # Konfigurationsbeschreibung fuer CE (Fortna: 02_KONFIGURATIONSBESCHREIBUNG)
einbauerklaerungen/ # NEU: Einbauerklaerungen + Montageanleitungen fuer eingebaute unvollstaendige Maschinen
konformitaetserklaerungen_komponenten/ # NEU: Sammlung der DoCs zugekaufter Komponenten (Querverweis auf 08_lieferantendoku)
```
Fortna-Beispieldokumente:
- EC Declaration of Conformity_V2_EN.pdf
- Konfigurationsbeschreibung_fuer_CE_V2.pdf
**Ergaenzung nach Anhang IV, Teil A, VO (EU) 2023/1230:** Die neuen Unterordner `einbauerklaerungen/` und `konformitaetserklaerungen_komponenten/` decken zwei Pflichtangaben ab, die im bisherigen Kapitelzuschnitt keinen festen Platz hatten:
- Einbauerklaerung + Montageanleitung fuer eingebaute unvollstaendige Maschinen (z. B. zugekaufte Antriebe/Steuerungen, die selbst als unvollstaendige Maschine geliefert werden)
- Konformitaetserklaerungen zugekaufter Komponenten – bisher nur implizit verstreut in `08_lieferantendoku/*` (nach Gewerk sortiert, nicht nach Dokumenttyp)
### 02_sicherheit
```text
02_sicherheit/
allgemein/ # Allgemeine Sicherheitshinweise
normen/ # Harmonisierte Normen, CE (EU), UKCA (UK) - je nach normen_region in anlage.json
gemeinsame_spezifikationen/ # NEU: "gemeinsame Spezifikationen" (Begriff aus VO (EU) 2023/1230, Art. 20)
sonstige_spezifikationen/ # NEU: sonstige angewandte techn. Spezifikationen, falls keine harmonisierte Norm existiert
risikobewertung/ # Risikomatrizen, Gefahrenanalysen
restrisiken/ # NEU: explizite Restrisiken-Section (bisher nur implizit in der Risikomatrix)
```
**Ergaenzung nach Anhang IV, Teil A:** Anhang IV verlangt explizit die Referenzen der angewandten harmonisierten Normen *oder gemeinsamen Spezifikationen* (bei Teilanwendung mit Angabe der verwendeten Teile), sowie – falls keine harmonisierten Normen angewandt wurden – die sonstigen angewandten technischen Spezifikationen. Bisher gab es dafuer nur den allgemeinen Ordner `normen/`. Ebenso verlangt Anhang IV eine Beschreibung der Restrisiken als Teil der Risikobeurteilungsunterlagen – dafuer bisher keine eigene Section, nur implizit in der Risikomatrix enthalten.
### 03_anlagenbeschreibung
Keine feste Unterstruktur - Module werden hier durch den Build-Prozess via meta.yaml eingefuegt. Jedes Modul liefert seine Beschreibung, technische Daten etc.
### 04_betrieb
```text
04_betrieb/
betriebsanleitung/ # Fortna: 01_BETRIEBSANLEITUNG_500592_V2.3.pdf
```
Fortna-Beispieldokumente:
- BETRIEBSANLEITUNG_500592_V2.3.pdf
### 05_wartung
```text
05_wartung/
wartungsanleitung/ # Fortna: 02_WARTUNGSANLEITUNG_500592_V2.2.pdf
schmierplan/ # Schmierstellen, Intervalle, Schmiermittel
```
### 06_steuerung
```text
06_steuerung/
(pro Steuerungssystem ein Unterordner)
ils/ # Fortna: 03_FUNKTION_STEUERUNG_ILS_500592_V2.1.pdf
omniflo/ # Fortna: 04_FUNKTION_STEUERUNG_OMNIFLO_500592_V1.0.pdf
loading_loop/ # Fortna: 05_FUNKTION_STEUERUNG_LoadingLoop_500592_V2.2.pdf
```
Unterordner werden projektspezifisch angelegt je nach verbauten Steuerungssystemen.
### 07_ersatzteile
Ersatzteillisten, ggf. mit Explosionszeichnungen.
Fortna-Beispiel: SPARE_PARTS_500592_EN_V2.1.pdf
### 08_lieferantendoku
```text
08_lieferantendoku/
antriebe/ # SEW, NORD, Leantechnik (Anleitungen + Datenblaetter)
elektrik/ # Siemens, Leuze, Cognex, Werma, Phoenix, Murrelektronik, etc.
pneumatik/ # Aventics, ITS
stahlbau/ # MiTek (As-Built, Statik, Zertifikate, Handover)
sicherheitseinrichtungen/ # ABS Sicherheitslinie, Schmersal etc.
```
Fortna-Lieferanten (Beispiele):
- SEW: Motor/Getriebe-Anleitungen, Movimot-DBC
- NORD: Getriebe/Motor LoadingLoop
- Siemens: 60+ Datenblaetter (SPS, HMI, Schuetze, Sicherungen)
- Leuze: Sensoren (Datenblaetter + CE-Zertifikate)
- Cognex: Scanner (DM280, DM370 Referenzhandbuecher)
- MiTek: Stahlbau (As-Built, Structural Calcs, Steel/Bolt/Paint Certs, RAMS, Handover)
- ABS: Sicherheitslinie (Anleitungen, Montage, Pruefbuch, Zeichnungen, Zertifikate)
- Aventics: Pneumatik (Filter, Druckregler, Absperrventil, Verteiler)
### 09_technische_unterlagen
```text
09_technische_unterlagen/
layouts/
mechanisch/ # Fortna: 04_TECHNICAL_DOC/01_LAYOUT/01_MECHANICAL
elektrisch/ # Fortna: 04_TECHNICAL_DOC/01_LAYOUT/02_ELECTRICAL
schaltplaene/ # Fortna: 04_DIAGRAMS (pro Steuerungsbereich/Controlarea)
notstopp/ # Fortna: 03_EMERGENCY_STOP (Plaene + E-Stop-Matrix)
bereichsstopp/ # Fortna: 02_AREA_STOP
```
Fortna-Beispieldokumente:
- Layout: 500592_10_5.14_Layout_V2.1_EN.pdf, Bereiche_V2.1_EN.pdf
- Schaltplaene: Circuit diagrams_Controlarea 1-7_EN.pdf (je Steuerungsbereich)
- Notstopp: ES500592_10_5-14_ILS-OF_cpl.-E-Stop-[EN].pdf + Emergency_Stop_Matrix_V1.5.pdf
- Bereichsstopp: ES500592_10_5-14_ILS-OF-Area-Stop-cpl.-[EN].pdf
### 10_anhang
```text
10_anhang/
pruefberichte/ # Fortna: 04_TECHNICAL_DOC/05_REPORTS
abnahmeprotokolle/ # Abnahmedokumentation
```
Fortna-Beispieldokumente:
- Schutz_gegen_automatischen_Wiederanlauf_V1.1.pdf
- Drehrichtung_Asynchronmotoren.pdf
- Erprobung_Anzeige_Bediengeraete.pdf
## Sprachtrennung
Fortna verwendet Unterordner pro Sprache innerhalb jedes Kapitels:
`01_DE_original/`, `02_EN/`, `03_CZ/`
Neues Konzept: Pro Sprache ein kompletter Dokumentenbaum auf Top-Level:
- `chapters/` = Deutsche Dokumentation (Standard/Master)
- Zukuenftig: `chapters_en/`, `chapters_cz/` etc. als eigenstaendige Kopien
Fallback-Mechanismus: Fehlt ein Dokument in einer Fremdsprache, wird die deutsche Version verwendet.
## Heutige Checkliste für die nötigen Dokumente aus der Automation
### 1. Layout Elektrik
- Elektrolayout
- Layout Kabelpritsche und Erdung
### 2. Schaltplan & Pneumatikplan
- Schaltplan (WSCAD Elektrisch)
- Pneumatikplan (WSCAD Elektrisch)
- PDF-Ausgabe
- Projektsicherung im WSCAD-Format
### 3. Layout Pneumatik
- Verschlauchungsplan
### 4. Ersatzteilliste Elektrik
- Ersatzteilliste für elektrische Komponenten als PDF-Dokument
### 5. Dokumentationen Elektrolieferanten
- Ablage der Datenblätter
- Dokumentationen der Elektrolieferanten
### 6. Netzwerkstrukturplanung
- Netzwerkstrukturplanung (ProNetPlan / WSCAD)
### 7. Betriebsanleitung Steuerung
- Bedienhandbuch
- Steuerungsanleitung
### 8. Software-Daten SPS
- SPS-Projektdaten mit Sicherung
- PDF-Ausdruck des SPS-Programms
### 9. Sicherheitsausdruck SPS
- Sicherheitsausdruck der SPS-Software
### 10. Prüfprotokoll externe Gewerke
- Prüfprotokolle für externe Gewerke im eigenen Lieferumfang (z. B. Brandschutztüre)
### 11. Sistema Sicherheitsbetrachtung
- Sicherheitsbetrachtung gemäß Sistema als PDF-Dokument
### 12. Prüfprotokolle Schaltschränke
- Prüfprotokolle der Schaltschrankprüfung als PDF-Dokument
### 13. Lizenzen
- Softwarelizenzen (z. B. Sinamics, TIA Portal, OPC UA)
### 14. Abschaltmatrix
- Emergency-Stop-Matrix (Abschaltmatrix) als PDF-Dokument
### 15. Layout Sicherheitsbereiche
- Layout der Sicherheitsbereiche zur Abschaltmatrix
### 16. Validierungsprotokolle
Unterschriebene Validierungsprotokolle, bestehend aus:
#### 16.1 Prüfprotokoll ortsfester Arbeitsmittel
- Elektrische Prüfung ortsfester Arbeitsmittel
#### 16.2 Erprobung Wiederanlauf
- Schutz gegen automatischen Wiederanlauf
#### 16.3 Erprobung Drehrichtung Motoren
- Test der Drehrichtung der Asynchronmotoren
#### 16.4 Berechnung Fehlerschleifenimpedanz / Validierung Erdung
- Berechnung der Fehlerschleifenimpedanz
- Erdungsvalidierung
#### 16.5 Erprobung Anzeige- und Bediengeräte
- Test der Anzeige- und Bediengeräte
# Fragen und TODOs
- [ ] Wie ist der Standardablauf der Dokumentation bisher?
- [ ] Wer ist wann daran bei einem einfach Projekt daran beteiligt?
- [ ] Was wäre bei einer Automatisierung der Dokumentations- Erstellung für die wünschenswert?
- [ ] Welche Ausnahmen sind üblich, fehlt oft oder ist nicht immer dabei?
- [ ] für wen ist die Dokumentation gedacht, bzw. was erwarten diese Leute zu finden?
- [ ] Welche Detailierungstiefe bei den Produkten ist nötig oder gewollt?
- [ ] soll die aktuelle Kapitelstruktur mit nur 4 Kapiteln beibehalten werden oder könnten wir dies auf ca. 7 - 10 Kapitel erweitern (siehe Vorschlag)?
- [ ] in welchem Kapitel sollen die jeweiligen Dokumente aus der Automation landen?
- [ ] Wie läuft die Ersatzteilfindung nach der Dokumentation statt?
- [ ] Wie die Behandlung einer Anlage bei Fehler oder Störungen?
- [ ] Welche Daten des Produktprogrammes sollen in die Dokumentation eingang finden?
- [ ] Welche Abteilung liefert normalerweise was in der Dokumentation (Liste Automation ist vorhanden, Was passiert bei Sonderkonstruktionen)?
- [ ] Soll die Rechtsgrundlage (MRL 2006/42/EG vs. VO (EU) 2023/1230) als Feld in `anlage.json` gefuehrt werden (analog zu `normen_region`), damit Textbausteine und Kapitelverweise projektspezifisch zwischen "Anhang I MRL" und "Anhang III/IV MVO" umschalten koennen? Relevant spaetestens ab Pflichtanwendung der MVO am 20.01.2027; Altprojekte (z. B. Fortna) bleiben MRL-referenziert.
## Ergaenzungsbedarf durch VO (EU) 2023/1230, Anhang IV Teil A
Anhang IV Teil A ersetzt Anhang VII der MRL 2006/42/EG und listet die Mindestinhalte der technischen Unterlagen fuer vollstaendige Maschinen. Abgleich mit der bestehenden Kapitelstruktur (Details siehe Abschnitte `01_zertifikate` und `02_sicherheit` oben):
| Anhang IV Teil A – Anforderung | Bereits abgedeckt durch | Ergaenzungsbedarf |
|---|---|---|
| Beschreibung der Maschine + bestimmungsgemaesse Verwendung | `03_anlagenbeschreibung` | Bestimmungsgemaesse Verwendung als Pflichtabschnitt je Modul sicherstellen |
| Risikobeurteilungsunterlagen inkl. GSGA-Liste, Schutzmassnahmen, Restrisiken | `02_sicherheit/risikobewertung` | Restrisiken als eigene Section (`restrisiken/`, s. o.) |
| Entwurfs-/Fertigungszeichnungen, Plaene | `09_technische_unterlagen/layouts`, `schaltplaene` | keiner |
| Erlaeuterungen zu Zeichnungen/Funktionsweise | `06_steuerung/*` | fuer rein mechanische Baugruppen ohne Steuerung ggf. in `03_anlagenbeschreibung` ergaenzen |
| Referenzen harmonisierter Normen/gemeinsamer Spezifikationen | `02_sicherheit/normen` | Unterordner `gemeinsame_spezifikationen/` (s. o.) |
| Sonstige angewandte technische Spezifikationen | – | Unterordner `sonstige_spezifikationen/` (s. o.) |
| Pruefberichte | `10_anhang/pruefberichte` | keiner |
| Exemplar der Betriebsanleitung | `04_betrieb/betriebsanleitung` | keiner |
| Einbauerklaerung + Montageanleitung fuer eingebaute unvollstaendige Maschinen | – | Neuer Ordner `01_zertifikate/einbauerklaerungen/` (s. o.) |
| Konformitaetserklaerungen zugekaufter Komponenten | bisher verstreut in `08_lieferantendoku/*` | Neuer Ordner `01_zertifikate/konformitaetserklaerungen_komponenten/` (s. o.) |
| Kopie der eigenen EU-Konformitaetserklaerung | `01_zertifikate/konformitaetserklaerung` | Ordner existiert, aktuell nur Platzhalter (`.gitkeep`) – inhaltlich zu befuellen |