MD Umbau

2026-05-13 11:57:52 +02:00
parent 6abf6f9c3d
commit f4511b9213
76 changed files with 4494 additions and 1940 deletions
--- a/markdown-beispielprojekt/README.md
+++ b/markdown-beispielprojekt/README.md
@@ -0,0 +1,37 @@
+# Markdown-Dokumentationsprojekt
+
+Dieses Beispiel zeigt die Zielstruktur fuer neue Produktdokumentationen.
+
+Jede Produktdokumentation liegt in einem eigenen GitLab-Projekt. Versionen werden weiterhin ueber Branches gepflegt, zum Beispiel `v1.0.0`, `v1.1.0` oder `v2.0.0`.
+
+## Pflichtstruktur
+
+```text
+doku.md
+stepbystep.md
+images/
+```
+
+## Empfohlene Struktur
+
+```text
+doku.md
+stepbystep.md
+faq.md
+doku.yml
+images/
+  produktbild.png
+  sf_tab1.png
+  allgemein.png
+  konfiguration.png
+```
+
+## Schreibregeln
+
+- `doku.md` ist die Startseite und beschreibt Produkt, Nutzen, Voraussetzungen, Download und Versionshinweise.
+- `stepbystep.md` enthaelt immer die konkrete Einrichtung und Konfiguration.
+- `faq.md` ist optional, aber empfohlen, sobald wiederkehrende Supportfragen entstehen.
+- Bilder liegen immer unter `images/` und werden relativ verlinkt, zum Beispiel `![Allgemein](images/allgemein.png)`.
+- Hinweise werden als Blockquote geschrieben: `> **Hinweis:** ...`
+- Kritische Punkte werden als Blockquote geschrieben: `> **Warnung:** ...`
+- Im Konfigurationsbereich wird die imperative Form verwendet, ohne direktes "Du".