CLAUDE.md – Projektkonventionen: GSHIP Dokumentation für docs.garbit.de

#Projektziel

Erstellung von Dokumentationsseiten für das Garbit GSHIP Connector-Handbuch im TYPEMILL-Format. Die fertigen Dateien werden per SFTP auf den Dokumentationsserver hochgeladen.

#Ordnerstruktur

Projekt 20260318 - GSHIP Dokumentation für docs.garbit.de/
├── CLAUDE.md                          ← diese Datei
├── [Seitennummer]-[thema]/            ← ein Ordner pro Dokumentationsseite
│   ├── [Seitennummer]-[thema].txt     ← TYPEMILL-Inhalt (Block-Editor-Draft)
│   ├── [Seitennummer]-[thema].yaml    ← TYPEMILL-Metadaten
│   └── sicherung/                     ← Sicherung der Original Dateien vor der Bearbeitung, darf nicht bearbeitet werden.
│   └── media/
│       └── live/
│           ├── [thema]-1.png          ← umbenannte Bilder (Zielname auf Server)
│           ├── [thema]-2.png
│           └── ...

Beispiel:

31-laender-verwalten/
├── 31-laender-verwalten.txt
├── 31-laender-verwalten.yaml
└── sicherung/
    ├── 31-laender-verwalten.txt
    └── sicherung/├── 31-laender-verwalten.yaml
└── media/
    └── live/
        ├── laender-1.png
        └── ...

#Dateibenennungs-Konventionen

#TYPEMILL-Dateien

• Schema: [Seitennummer]-[thema-kebab-case].txt und .yaml
• Beispiel: 31-laender-verwalten.txt
• Seitennummer wird vom Auftraggeber vorgegeben
• Ordnername = Dateiname ohne Erweiterung

#Bilder

• Umbenennungsschema: [thema]-[nummer].png
• Beispiel: laender-1.png, laender-2.png, …
• Ablageort: [Ordner]/media/live/

#TYPEMILL-Dateiformat

#`.yaml` – Metadaten

meta:
    title: ''
    description: ''
    owner: schubert
    author: schubert
    created: 'YYYY-MM-DD'
    time: HH-MM-SS
    navtitle: 'Seitentitel in Navigation'
    modified: 'YYYY-MM-DD'

#`.txt` – Inhalt (Block-Editor-Draft)

• Format: JSON-Array aus Markdown-Strings (ein Block = ein Array-Element)
• Wird vom TYPEMILL Block-Editor als Draft-Version verwendet

Bild-Syntax:

"![Alttext](media/live/dateiname.png \"Bildtitel\"){.center}\n*Bildunterschrift*"

Info-Box:

"! Infotext hier"

Nummerierte Schritte:

"**1.** Beschreibung des Schritts."

Fette UI-Elemente: **Schaltflächenname**

#Workflow für neue Dokumentationsseite

1. Ordner anlegen

   • Neuen Ordner [Seitennummer]-[thema]/ im Projektverzeichnis erstellen
   • Unterordner media/live/ darin anlegen

2. Bilder vorbereiten

   • Screenshots nach [Ordner]/media/live/ ablegen
   • Umbenennen nach Schema [thema]-[nummer].png

3. TYPEMILL-Dateien erstellen

   • [Seitennummer]-[thema].yaml mit Metadaten anlegen
   • [Seitennummer]-[thema].txt als JSON-Array mit Markdown-Blöcken anlegen
   • Bildpfade referenzieren als media/live/[thema]-[nummer].png

4. Aufgabe abschließen – Upload-Paket bereitstellen

   • Alle Bilder liegen korrekt benannt in [Ordner]/media/live/
   • [Seitennummer]-[thema].txt enthält alle Bildverweise auf media/live/[thema]-[nummer].png
   • [Seitennummer]-[thema].yaml ist vollständig befüllt
   • Ordnername stimmt exakt mit dem Dateinamen (ohne Erweiterung) überein
   • Der Nutzer kann den Ordnerinhalt direkt per SFTP hochladen – ohne manuelle Nacharbeit

Wichtig: Erst wenn alle drei Punkte (Bilder, .txt, .yaml) korrekt und konsistent im Ordner vorliegen, gilt die Aufgabe als abgeschlossen.

#Stil-Konventionen (angelehnt an docs.garbit.de)

• Jeder Schritt erhält einen Screenshot mit Bildunterschrift
• Schritte sind nummeriert: **1.**, **2.**, …
• UI-Elementnamen immer fett formatieren
• Info-Boxen (! Text) für wichtige Hinweise verwenden
• Einleitungstext beschreibt kurz den Zweck der Seite
• Sprache: Deutsch
• Referenzstil: https://docs.garbit.de/garbit-gship/zuordnung-der-adressfelder