From 367eb38cc81e448f70c8c2fde200870c47d5d7e7 Mon Sep 17 00:00:00 2001 From: Michael Stangl Date: Tue, 28 Apr 2026 23:30:56 +0200 Subject: [PATCH] Andere Kapitelstruktur aufgesetzt, Bsp. Fortna --- CLAUDE.md | 20 ++- .../.gitkeep | 0 .../konfigurationsbeschreibung}/.gitkeep | 0 .../konformitaetserklaerung}/.gitkeep | 0 .../allgemein}/.gitkeep | 0 .../normen}/.gitkeep | 0 .../risikobewertung}/.gitkeep | 0 .../04_betrieb/betriebsanleitung/.gitkeep | 0 chapters/05_wartung/schmierplan/.gitkeep | 0 .../05_wartung/wartungsanleitung/.gitkeep | 0 chapters/06_steuerung/.gitkeep | 0 chapters/07_ersatzteile/.gitkeep | 0 chapters/08_lieferantendoku/antriebe/.gitkeep | 0 chapters/08_lieferantendoku/elektrik/.gitkeep | 0 .../08_lieferantendoku/pneumatik/.gitkeep | 0 .../sicherheitseinrichtungen/.gitkeep | 0 chapters/08_lieferantendoku/stahlbau/.gitkeep | 0 .../bereichsstopp/.gitkeep | 0 .../layouts/elektrisch/.gitkeep | 0 .../layouts/mechanisch/.gitkeep | 0 .../notstopp/.gitkeep | 0 .../schaltplaene/.gitkeep | 0 chapters/10_anhang/abnahmeprotokolle/.gitkeep | 0 chapters/10_anhang/pruefberichte/.gitkeep | 0 doc/{..allFortna.txt => Fortna.txt} | 7 +- doc/kapitelstruktur.md | 150 ++++++++++++++++++ 26 files changed, 171 insertions(+), 6 deletions(-) rename chapters/{01_einleitung => 00_inhaltsverzeichnis}/.gitkeep (100%) rename chapters/{02_sicherheit => 01_zertifikate/konfigurationsbeschreibung}/.gitkeep (100%) rename chapters/{04_betrieb => 01_zertifikate/konformitaetserklaerung}/.gitkeep (100%) rename chapters/{05_wartung => 02_sicherheit/allgemein}/.gitkeep (100%) rename chapters/{06_ersatzteile => 02_sicherheit/normen}/.gitkeep (100%) rename chapters/{07_anhang => 02_sicherheit/risikobewertung}/.gitkeep (100%) create mode 100644 chapters/04_betrieb/betriebsanleitung/.gitkeep create mode 100644 chapters/05_wartung/schmierplan/.gitkeep create mode 100644 chapters/05_wartung/wartungsanleitung/.gitkeep create mode 100644 chapters/06_steuerung/.gitkeep create mode 100644 chapters/07_ersatzteile/.gitkeep create mode 100644 chapters/08_lieferantendoku/antriebe/.gitkeep create mode 100644 chapters/08_lieferantendoku/elektrik/.gitkeep create mode 100644 chapters/08_lieferantendoku/pneumatik/.gitkeep create mode 100644 chapters/08_lieferantendoku/sicherheitseinrichtungen/.gitkeep create mode 100644 chapters/08_lieferantendoku/stahlbau/.gitkeep create mode 100644 chapters/09_technische_unterlagen/bereichsstopp/.gitkeep create mode 100644 chapters/09_technische_unterlagen/layouts/elektrisch/.gitkeep create mode 100644 chapters/09_technische_unterlagen/layouts/mechanisch/.gitkeep create mode 100644 chapters/09_technische_unterlagen/notstopp/.gitkeep create mode 100644 chapters/09_technische_unterlagen/schaltplaene/.gitkeep create mode 100644 chapters/10_anhang/abnahmeprotokolle/.gitkeep create mode 100644 chapters/10_anhang/pruefberichte/.gitkeep rename doc/{..allFortna.txt => Fortna.txt} (99%) create mode 100644 doc/kapitelstruktur.md diff --git a/CLAUDE.md b/CLAUDE.md index 9a31d5b..3811359 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -28,7 +28,7 @@ Python-Code kommt nach `lib/`, Konfiguration nach `cfg/`. Die `bin/`-Skripte set Dieses Repo (`docu_build`) dient als Entwicklungs- und Planungsumgebung. Das Zielsystem besteht aus zwei getrennten Repos: -- **transport-docs-base** (Gitea): Wiederverwendbare Inhalte – Sphinx-Extensions (`_ext/`), Module (`modules/`), Kapitelgerüste (`chapters/`), Assets, Glossar, LaTeX-Templates. Semver-versioniert via `VERSION`-Datei. +- **transport-docs-base** (Gitea, = dieses Repo): Wiederverwendbare Inhalte – Sphinx-Extensions (`_ext/`), Module (`modules/`), Kapitelgerüste (`chapters/`), Assets, Glossar, LaTeX-Templates. Semver-versioniert via `VERSION`-Datei. - **projekt-kunde-xyz** (pro Anlage): `anlage.json` (ERP-Export), projektspezifische Bilder, Overrides, `conf.py`, `build.py`. Bindet Base-Repo als `transport-docs-base/` ein (Symlink/Mount). ### Technologie-Stack @@ -49,6 +49,24 @@ Sphinx + reStructuredText + Jinja2-Templating → LaTeX → PDF. Konfiguration v **meta.yaml** (pro Modul): Definiert `display_name` (mehrsprachig), `chapters` (Kapitelzuordnung mit Sections), `images` (shared/localized/module_local), `requires` (Abhängigkeiten). +### Kapitelstruktur (`chapters/`) + +```text +00_inhaltsverzeichnis – Inhaltsverzeichnis (wird generiert) +01_zertifikate – CE/UKCA-Konformität, Konfigurationsbeschreibung +02_sicherheit – Allgemein, Normen, Risikobewertung +03_anlagenbeschreibung – Module werden hier via meta.yaml eingefügt +04_betrieb – Betriebsanleitung +05_wartung – Wartungsanleitung, Schmierplan +06_steuerung – Funktionsbeschreibungen pro Steuerungssystem +07_ersatzteile – Ersatzteillisten +08_lieferantendoku – Antriebe, Elektrik, Pneumatik, Stahlbau, Sicherheitseinr. +09_technische_unterlagen – Layouts, Schaltpläne, Notstopp, Bereichsstopp +10_anhang – Prüfberichte, Abnahmeprotokolle +``` + +Details siehe `doc/kapitelstruktur.md`. + ### Sphinx-Extensions (zu implementieren in `_ext/`) - **anlagen_builder.py**: JSON + meta.yaml → toctree-Einträge, Abhängigkeitsauflösung (topologisch), Override-Logik diff --git a/chapters/01_einleitung/.gitkeep b/chapters/00_inhaltsverzeichnis/.gitkeep similarity index 100% rename from chapters/01_einleitung/.gitkeep rename to chapters/00_inhaltsverzeichnis/.gitkeep diff --git a/chapters/02_sicherheit/.gitkeep b/chapters/01_zertifikate/konfigurationsbeschreibung/.gitkeep similarity index 100% rename from chapters/02_sicherheit/.gitkeep rename to chapters/01_zertifikate/konfigurationsbeschreibung/.gitkeep diff --git a/chapters/04_betrieb/.gitkeep b/chapters/01_zertifikate/konformitaetserklaerung/.gitkeep similarity index 100% rename from chapters/04_betrieb/.gitkeep rename to chapters/01_zertifikate/konformitaetserklaerung/.gitkeep diff --git a/chapters/05_wartung/.gitkeep b/chapters/02_sicherheit/allgemein/.gitkeep similarity index 100% rename from chapters/05_wartung/.gitkeep rename to chapters/02_sicherheit/allgemein/.gitkeep diff --git a/chapters/06_ersatzteile/.gitkeep b/chapters/02_sicherheit/normen/.gitkeep similarity index 100% rename from chapters/06_ersatzteile/.gitkeep rename to chapters/02_sicherheit/normen/.gitkeep diff --git a/chapters/07_anhang/.gitkeep b/chapters/02_sicherheit/risikobewertung/.gitkeep similarity index 100% rename from chapters/07_anhang/.gitkeep rename to chapters/02_sicherheit/risikobewertung/.gitkeep diff --git a/chapters/04_betrieb/betriebsanleitung/.gitkeep b/chapters/04_betrieb/betriebsanleitung/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/05_wartung/schmierplan/.gitkeep b/chapters/05_wartung/schmierplan/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/05_wartung/wartungsanleitung/.gitkeep b/chapters/05_wartung/wartungsanleitung/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/06_steuerung/.gitkeep b/chapters/06_steuerung/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/07_ersatzteile/.gitkeep b/chapters/07_ersatzteile/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/08_lieferantendoku/antriebe/.gitkeep b/chapters/08_lieferantendoku/antriebe/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/08_lieferantendoku/elektrik/.gitkeep b/chapters/08_lieferantendoku/elektrik/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/08_lieferantendoku/pneumatik/.gitkeep b/chapters/08_lieferantendoku/pneumatik/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/08_lieferantendoku/sicherheitseinrichtungen/.gitkeep b/chapters/08_lieferantendoku/sicherheitseinrichtungen/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/08_lieferantendoku/stahlbau/.gitkeep b/chapters/08_lieferantendoku/stahlbau/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/09_technische_unterlagen/bereichsstopp/.gitkeep b/chapters/09_technische_unterlagen/bereichsstopp/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/09_technische_unterlagen/layouts/elektrisch/.gitkeep b/chapters/09_technische_unterlagen/layouts/elektrisch/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/09_technische_unterlagen/layouts/mechanisch/.gitkeep b/chapters/09_technische_unterlagen/layouts/mechanisch/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/09_technische_unterlagen/notstopp/.gitkeep b/chapters/09_technische_unterlagen/notstopp/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/09_technische_unterlagen/schaltplaene/.gitkeep b/chapters/09_technische_unterlagen/schaltplaene/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/10_anhang/abnahmeprotokolle/.gitkeep b/chapters/10_anhang/abnahmeprotokolle/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/chapters/10_anhang/pruefberichte/.gitkeep b/chapters/10_anhang/pruefberichte/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/..allFortna.txt b/doc/Fortna.txt similarity index 99% rename from doc/..allFortna.txt rename to doc/Fortna.txt index 063b611..b1a94b6 100644 --- a/doc/..allFortna.txt +++ b/doc/Fortna.txt @@ -496,9 +496,6 @@ │   │   └── 04_IU-Distrib_Rozdělovač_CZ.pdf │   └── 02_ITS │   └── KC-0167-00-01-4 Air distributor.pdf -├── FUNKTION_CONTROL_LoadingLoop_500592_V2.2_EN.docx -├── FUNKTION_STEUERUNG_LoadingLoop_500592_V2.2.docx -├── RB_Fortna_H+M_500592_EV12_20260311.docx -└── RB_Fortna_H+M_500592_V12_20260311.docx -123 directories, 378 files + +123 directories, 374 files diff --git a/doc/kapitelstruktur.md b/doc/kapitelstruktur.md new file mode 100644 index 0000000..f397c32 --- /dev/null +++ b/doc/kapitelstruktur.md @@ -0,0 +1,150 @@ +# 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 | 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) +``` + +Fortna-Beispieldokumente: +- EC Declaration of Conformity_V2_EN.pdf +- Konfigurationsbeschreibung_fuer_CE_V2.pdf + +### 02_sicherheit + +```text +02_sicherheit/ + allgemein/ # Allgemeine Sicherheitshinweise + normen/ # CE (EU), UKCA (UK) - je nach normen_region in anlage.json + risikobewertung/ # Risikomatrizen, Gefahrenanalysen +``` + +### 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.