mermaidPockedGuide/template.md

➖ Projektvorlage

Ein wiederverwendbares Grundgerüst für Mermaid-Diagramme in Projekten – ideal für schnelle Abläufe, Prozessbeschreibungen oder Dokumentationsmodule.

---

🧩 Beispiel für ein einfaches Ablaufdiagramm

flowchart TD
    Init((Start))
    Schritt1[⏳ Prozessschritt 1]
    Schritt2[⚙ Verarbeitung]
    Ergebnis{Erfolg?}
    Positiv[✔ Erfolgreich]
    Negativ[✖ Fehler]
    Fertig((Fertig))

    Init --> Schritt1 --> Schritt2 --> Ergebnis
    Ergebnis -- Ja --> Positiv --> Fertig
    Ergebnis -- Nein --> Negativ --> Fertig

---

📁 Ordnerstruktur-Vorschlag

docs/
  diagrams/
    main.mmd       # Mermaid-Quelldatei
    main.svg       # Exportiertes Diagramm
README.md          # Referenz auf das Diagramm
Makefile           # Automatisierter Export

---

🛠 Makefile-Snippet für automatische Generierung

diagrams/main.svg: diagrams/main.mmd
	mmdc -i diagrams/main.mmd -o diagrams/main.svg -t neutral

---

🔗 Verlinkung im README.md

## 🔍 Prozessübersicht

![Ablaufdiagramm](docs/diagrams/main.svg)

---

📌 Empfehlung

• Diagramme als .mmd separat pflegen – kein Inline-Markdown
• Automatisch als .svg oder .png exportieren
• Diagramme per Git versionieren
• In CI/CD-Pipeline oder Build-System integrieren

---