Richte Nutzerdoku auf Bedienungsanleitung mit Frontend-Seitenkategorie aus
This commit is contained in:
@@ -1,46 +1,64 @@
|
||||
# FEDEO Funktionsdokumentation
|
||||
---
|
||||
seo:
|
||||
title: FEDEO Bedienungsanleitung
|
||||
description: Nutzerorientierte Bedienungsanleitung für alle zentralen Funktionen in FEDEO.
|
||||
---
|
||||
|
||||
Diese Dokumentation bildet alle Funktionen der Software zentral ab und ist für die Nutzung in der Nuxt-Content-Docs-Homepage vorbereitet.
|
||||
::u-page-hero{class="dark:bg-gradient-to-b from-neutral-900 to-neutral-950"}
|
||||
---
|
||||
orientation: horizontal
|
||||
---
|
||||
#title
|
||||
FEDEO [Bedienungsanleitung]{.text-primary}
|
||||
|
||||
## Ziel
|
||||
#description
|
||||
Diese Dokumentation ist als praktische Anleitung für Anwenderinnen und Anwender der FEDEO-Software aufgebaut.
|
||||
|
||||
- Vollständige Übersicht über Funktionen in Backend, Web-Frontend und Mobile-App
|
||||
- Nachvollziehbare Versionierung der Doku
|
||||
- Einfache Aktualisierung bei Funktionsänderungen
|
||||
#links
|
||||
:::u-button
|
||||
---
|
||||
to: /bedienung
|
||||
size: xl
|
||||
trailing-icon: i-lucide-arrow-right
|
||||
---
|
||||
Zur Bedienungsanleitung
|
||||
:::
|
||||
|
||||
## Struktur
|
||||
:::u-button
|
||||
---
|
||||
to: /bedienung/frontend
|
||||
size: xl
|
||||
color: neutral
|
||||
variant: outline
|
||||
---
|
||||
Frontend-Funktionen
|
||||
:::
|
||||
::
|
||||
|
||||
- `docs/funktionen/uebersicht.md`: Fachliche Gesamtübersicht der Bereiche
|
||||
- `docs/funktionen/backend-api.md`: Automatisch erzeugte API-Funktionsliste
|
||||
- `docs/funktionen/frontend-web.md`: Automatisch erzeugte Seiten-/Funktionsliste des Web-Frontends
|
||||
- `docs/funktionen/mobile-app.md`: Automatisch erzeugte Screens-/Funktionsliste der Mobile-App
|
||||
- `docs/versionen/docs-versionen.md`: Versionierung der Dokumentation
|
||||
- `docs/wartung/dokumentationsprozess.md`: Prozess, damit die Doku dauerhaft aktuell bleibt
|
||||
- `docs/scripts/sync-funktionsdoku.mjs`: Skript zur automatischen Aktualisierung
|
||||
::u-page-section{class="dark:bg-neutral-950"}
|
||||
#title
|
||||
Inhalte
|
||||
|
||||
## Aktualisierung bei Funktionsänderungen
|
||||
#features
|
||||
:::u-page-feature
|
||||
---
|
||||
icon: i-lucide-layout-dashboard
|
||||
---
|
||||
#title
|
||||
Frontend-Seiten
|
||||
|
||||
Bei jeder Funktionsänderung bitte ausführen:
|
||||
#description
|
||||
Übersicht aller Seitenfunktionen inklusive Eingabefelder und deren Bedeutung.
|
||||
:::
|
||||
|
||||
```bash
|
||||
node docs/scripts/sync-funktionsdoku.mjs
|
||||
```
|
||||
:::u-page-feature
|
||||
---
|
||||
icon: i-lucide-file-text
|
||||
---
|
||||
#title
|
||||
Praxisnahe Feld-Erklärungen
|
||||
|
||||
Danach:
|
||||
|
||||
1. Änderungen in `docs/funktionen/*.md` prüfen
|
||||
2. Falls nötig fachliche Texte in `docs/funktionen/uebersicht.md` ergänzen
|
||||
3. Eintrag in `docs/versionen/docs-versionen.md` ergänzen
|
||||
4. Alles gemeinsam committen
|
||||
|
||||
## Verwendung mit Nuxt Content
|
||||
|
||||
Empfohlene Vorgehensweise:
|
||||
|
||||
1. `docs/` in das Content-Verzeichnis übernehmen (oder per Sync einbinden)
|
||||
2. Navigation anhand der Ordner `funktionen`, `wartung`, `versionen` aufbauen
|
||||
3. `backend-api.md`, `frontend-web.md`, `mobile-app.md` als referenzierende Funktionskataloge einbinden
|
||||
|
||||
## Hinweis
|
||||
|
||||
Die Dateien `backend-api.md`, `frontend-web.md` und `mobile-app.md` werden automatisch generiert. Manuelle Änderungen in diesen Dateien werden bei der nächsten Synchronisation überschrieben.
|
||||
#description
|
||||
Für zentrale Masken wie den Ausgangsbeleg-Editor werden die Felder konkret erläutert.
|
||||
:::
|
||||
::
|
||||
|
||||
Reference in New Issue
Block a user