MD Umbau

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".

markdown-beispielprojekt/doku.md

@@ -0,0 +1,108 @@
+# Testdoku
+
+Dokumentation fuer Modulversion **X.X.X vXXX** ab **STARFACE 9.0.0.0**.
+
+## Produktbeschreibung
+
+Beschreibe hier das Modul in neutraler Form. Der Text kann perspektivisch aus SAP oder aus vertrieblichem Input uebernommen werden.
+
+- Produktbeschreibung und vertrieblicher Nutzen
+- Wichtige Einsatzbereiche
+- Verweis auf den Shop oder die Produktseite
+- Produktbild, falls vorhanden
+
+![Produktbild](images/produktbild.png)
+
+## Anwendungsbeispiel
+
+Beschreibe hier, wofuer das Modul in der Praxis verwendet wird. Bei fachlichen Unklarheiten sollte das Beispiel mit Entwicklung, Vertrieb oder Support abgestimmt werden.
+
+## Technische Voraussetzungen
+
+- **Ab STARFACE 9.0.0.0**
+- Fuer dieses Modul stehen Legacy-Versionen ab STARFACE 7.0.0.2 zur Verfuegung.
+- Cloud-Anforderungen, zum Beispiel SSH-Tunnel
+- Anforderungen an Drittsysteme oder Anbieter
+- Optionale Anforderungen fuer bestimmte Funktionen
+- Anforderungen an Hardware
+- Getestet mit Version X einer externen Software oder API
+
+## Technische Limitierungen
+
+Dieser Abschnitt ist optional und wird bei Bedarf in Abstimmung mit Entwicklung, Vertrieb und Support eingefuegt.
+
+- Maximale Importanzahl
+- API-Limits
+- Bekannte Einschraenkungen durch Drittsysteme
+
+## Vertriebsmodelle
+
+- Kauf inklusive SPV
+- Managed Service
+- Weitere Modelle
+
+## Modulvarianten
+
+Dieser Abschnitt ist optional und beschreibt Varianten fuer verschiedene Drittsysteme, zum Beispiel Google, XML-Monitoring oder andere Anbieter.
+
+## Einrichtung und Konfiguration
+
+Die konkrete Einrichtung ist in der Schritt-fuer-Schritt-Anleitung beschrieben:
+
+[Zur Schritt-fuer-Schritt-Anleitung](stepbystep.md)
+
+## Bekannte Probleme
+
+- Bei diesem Modul liegen keine bekannten Probleme vor.
+- Problem entdeckt? Schicke eine E-Mail an [support@o-byte.com](mailto:support@o-byte.com), um Fehler zu melden.
+
+Alternativ koennen bekannte Probleme so dokumentiert werden:
+
+### Problem 1
+
+Beschreibe hier das Problem.
+
+**Loesung:** Beschreibe hier die Loesung oder den Workaround.
+
+## Versionshinweis
+
+### X.X.X
+
+**Bugfix**
+
+- Welcher Fehler wurde behoben?
+
+**Neue Funktion**
+
+- Welche neue Funktion wurde eingebaut?
+
+> **Hinweis:** Wenn ein Bugfix ein bekanntes Problem behebt, den Abschnitt "Bekannte Probleme" ebenfalls aktualisieren.
+
+## Download
+
+### Modul ohne Testzeitraum
+
+Fuer dieses Modul steht kein Testzeitraum von 14 Tagen zur Verfuegung. Das Modul wird erst mit Kauf aktiv. Unser Vertriebsteam hilft gerne weiter unter [vertrieb@o-byte.com](mailto:vertrieb@o-byte.com).
+
+Bitte achte beim Download auf die Kompatibilitaet zur STARFACE-Version.
+
+Mit Klick auf den Downloadlink einer Modulversion oeffnen sich ein Fenster mit Installationshinweisen und ein Pop-up-Fenster.
+
+[Zum Download](https://get.o-byte.com/?olm=olm-)
+
+### Modul mit Testzeitraum
+
+- Wir stellen unser Modul 14 Tage kostenfrei zum Testen zur Verfuegung.
+- Nach dem Kauf oder Update: Mit E-Mail-Adresse verifizieren.
+- Fuer die Inbetriebnahme oder das Update ist kein Lizenzschluessel noetig.
+- Wir stellen das Modul als `.sfm` Datei zur Verfuegung.
+
+Bitte achte beim Download auf die Kompatibilitaet zur STARFACE-Version.
+
+Mit Klick auf den Downloadlink einer Modulversion oeffnen sich ein Fenster mit Installationshinweisen und ein Pop-up-Fenster.
+
+- Kostenfreies Modul laden: Trage die E-Mail-Adresse ein, stimme der Datenschutzbestimmung zu und klicke auf "Download". Der Downloadlink wird per Mail zur Verfuegung gestellt.
+- Nach dem Kauf oder Update: Mit E-Mail-Adresse verifizieren. Fuer die Inbetriebnahme oder das Update ist kein Lizenzschluessel noetig.
+- Wir stellen das Modul als `.sfm` Datei zur Verfuegung.
+
+[Zum Download](https://get.o-byte.com/?olm=olm-)

markdown-beispielprojekt/doku.yml

@@ -0,0 +1,13 @@
+title: Testdoku
+version: X.X.X
+revision: vXXX
+starface: "ab STARFACE 9.0.0.0"
+date: 2025-01-01
+start: doku.md
+nav:
+  - title: Uebersicht
+    file: doku.md
+  - title: Schritt fuer Schritt
+    file: stepbystep.md
+  - title: FAQ
+    file: faq.md

markdown-beispielprojekt/faq.md

@@ -0,0 +1,15 @@
+# FAQ
+
+Diese Seite ist optional, aber empfohlen, sobald wiederkehrende Supportfragen entstehen.
+
+## Frage 1
+
+Antwort auf die erste haeufig gestellte Frage.
+
+## Frage 2
+
+Antwort auf die zweite haeufig gestellte Frage.
+
+## Wann soll ein FAQ-Eintrag angelegt werden?
+
+Ein FAQ-Eintrag ist sinnvoll, wenn mehrere Supportanfragen zum gleichen Thema entstehen oder eine Konfigurationsentscheidung erfahrungsgemaess erklaert werden muss.

markdown-beispielprojekt/images/.gitkeep

@@ -0,0 +1 @@
+

markdown-beispielprojekt/stepbystep.md

@@ -0,0 +1,81 @@
+# Schritt-fuer-Schritt-Anleitung
+
+Diese Seite beschreibt die konkrete Einrichtung und Konfiguration des Moduls.
+
+Im Konfigurationsbereich wird die imperative Form verwendet. Ein direktes "Du" wird vermieden. Wenn der Nutzer nicht direkt angesprochen wird, wird die neutrale Form verwendet.
+
+## Vorbereitung der IT-Umgebung
+
+- Infrastruktur fuer den Betrieb des Moduls aufsetzen und konfigurieren.
+- Falls noetig, Voraussetzungen in Partnersystemen herstellen.
+- Zugangsdaten, API-Schluessel oder Netzwerkfreigaben vorbereiten.
+
+## Konfiguration der Drittsysteme
+
+Beschreibe hier, welche Einstellungen in Drittsystemen vorgenommen werden muessen.
+
+- Einstellung 1
+- Einstellung 2
+- Einstellung 3
+
+## STARFACE-Konfiguration
+
+### Menuepunkt
+
+#### Tab
+
+![STARFACE Tab](images/sf_tab1.png)
+
+> **Bildkonvention:** Dateiname = Tab-Ueberschrift. Bei STARFACE-Konfigurationen wird das Praefix `sf_` verwendet.
+
+##### Unterpunkt
+
+- Einstellungen beschreiben, die an der STARFACE selbst vorgenommen werden, zum Beispiel am STARFACE-internen Adressbuch oder am Netzwerk.
+- Wenn keine STARFACE-Konfiguration erforderlich ist: "Es muss vorab keine Konfiguration in der STARFACE vorgenommen werden."
+
+## Modulkonfiguration
+
+### Allgemein
+
+![Allgemein](images/allgemein.png)
+
+> **Bildkonvention:** Dateiname = Tab-Ueberschrift.
+
+#### Name
+
+Waehle hier den Namen der Modulinstanz. Dieser Name sollte moeglichst beschreibend vergeben werden. Ein guter Ausgangspunkt ist der Name des Moduls. Sollen mehrere Instanzen desselben Moduls aktiv sein, muss fuer jede Instanz ein einmaliger Name vergeben werden.
+
+#### Beschreibung
+
+Dieses Feld bietet Raum fuer eine detailliertere Dokumentation der Instanz. Hier kann beispielsweise dokumentiert werden, auf welche Nutzer oder Gruppen das Modul zugreift.
+
+#### Logdatei
+
+Jedes Modul informiert in den Levels `ERROR`, `WARN`, `INFO`, `DEBUG` und `TRACE` in verschiedenen Abstufungen ueber Prozesse, die im Modulbetrieb ablaufen. Falls ein Fehler auftritt, besteht hier die Moeglichkeit, die Logdatei zu speichern. Standardeinstellung ist das Level `INFO`.
+
+> **Hinweis:** Das Log aktualisiert sich nicht automatisch, sondern nur, wenn die entsprechende Schaltflaeche betaetigt wird.
+
+### Konfiguration
+
+![Konfiguration](images/konfiguration.png)
+
+#### Unterpunkt in Tab
+
+##### Auf einzelne Punkte eingehen
+
+Beschreibe hier die konkrete Einstellung.
+
+> **Hinweis:** In den meisten Faellen werden Rufnummern in das Format `00492515906850` normalisiert. In Ausnahmefaellen koennen aber auch Formate wie `+492515906850` oder `02515906850` signalisiert werden. Daher wird grundsaetzlich die Verwendung von Wildcards bei der Quellrufnummer empfohlen, zum Beispiel `*2515906850`.
+
+##### Legende
+
+- `?` - Platzhalter fuer eine Ziffer
+- `*` - Platzhalter fuer eine, mehrere oder keine Ziffern
+
+## Abschlusspruefung
+
+- Modulinstanz speichern.
+- Modul aktivieren.
+- Funktion mit einem realistischen Szenario testen.
+- Logdatei pruefen.
+- Dokumentierte Voraussetzungen und bekannte Probleme gegenpruefen.