Richte Nutzerdoku auf Bedienungsanleitung mit Frontend-Seitenkategorie aus

This commit is contained in:
2026-04-22 19:21:32 +02:00
parent 6224a25c38
commit 3562d55a12
17 changed files with 7384 additions and 1297 deletions

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,62 @@
# Ausgangsbeleg-Editor
Seite: `/createDocument/edit/:id?`
Diese Maske dient zum Erstellen und Bearbeiten von Ausgangsbelegen wie Rechnungen, Abschlagsrechnungen, Angebote, Lieferscheine, Packscheine und Serienrechnungen.
## Bereich: Grunddaten
- `Dokumenttyp`: Legt die Belegart fest und steuert verfügbare Felder sowie Nummernlogik.
- `Steuertyp`: Steuert Steuerberechnung und Steuertexte (z. B. Standard, 13b UStG, 19 UStG, 12.3 UStG).
- `Briefpapier`: Definiert das verwendete Layout/Letterhead für PDF und Druck.
- `Kunde`: Hauptempfänger des Belegs; beeinflusst Vorschlagswerte (Adresse, Zahlungsart, Zahlungsziel).
- `Ansprechpartner`: Kontaktperson beim Kunden für den Beleg.
- `Adresse`:
- `Straße + Hausnummer`: Liefer-/Rechnungsstraße.
- `Adresszusatz`: Zusätzliche Adressinformationen.
- `PLZ`: Postleitzahl.
- `Ort`: Ort der Adresse.
- `Belegnummer` (z. B. Rechnungsnummer): Eindeutige Referenz des Belegs.
- `Lieferdatumsart`: Definiert, ob Einzel- oder Zeitraumdatum angezeigt wird.
- `Liefer-/Leistungsdatum Start`: Startdatum für Leistung/Lieferung.
- `Liefer-/Leistungsdatum Ende`: Enddatum bei Zeitraum.
- `Belegdatum`: Offizielles Dokumentdatum.
- `Zahlungsziel in Tagen`: Frist bis zur Fälligkeit (für Rechnungsarten).
- `Zahlungsart`: Überweisung oder SEPA-Lastschrift.
- `Individueller Aufschlag`: Prozentualer Zuschlag auf Positionen laut Beleglogik.
- `Mitarbeiter`: Verantwortlicher Bearbeiter/Ersteller.
- `Kontakt Telefon`: Telefon des Ansprechpartners im Dokument.
- `Kontakt E-Mail`: E-Mail des Ansprechpartners im Dokument.
- `Im Kundenportal anzeigen`: Gibt den Beleg für das Portal frei.
- `Objekt`: Zugeordnetes Objekt/Standort.
- `Projekt`: Zugeordnetes Projekt.
- `Vertrag`: Zugeordneter Vertrag.
## Bereich: Serienrechnung (nur Typ `serialInvoices`)
- `Datum erste Ausführung`: Start der automatischen Ausführung.
- `Datum letzte Ausführung`: Enddatum der Serienausführung.
- `Aktiv`: Aktiviert/deaktiviert die Serienlogik.
- `Intervall`: Ausführungsrhythmus (z. B. monatlich, vierteljährlich).
- `Richtung`: Zeitliche Berechnung (rückwirkend oder im Voraus).
## Bereich: Inhaltstexte
- `Titel`: Belegtitel (abhängig von Belegart und Nummernlogik).
- `Beschreibung`: Kurzbeschreibung unterhalb des Titels.
- `Vorlage auswählen`: Übernimmt Textbausteine in den Einleitungstext.
- `Einleitung`: Freitext vor den Positionen.
- `Positionen`: Zeilen mit Mengen, Einheiten, Preisen, Steuern, Rabatten und Summen.
## Bereich: Aktionen
- `Speichern`: Persistiert Entwurf oder Änderungen.
- `Buchen`: Finalisiert den Beleg (abhängig von Belegart/Validierung).
- `PDF/Vorschau`: Erstellt Vorschau bzw. Ausgabe.
- `Kopier-/Übernahmefunktionen`: Übernimmt Inhalte aus verknüpften Dokumenten (z. B. Lieferschein zu Rechnung).
## Typische Eingabefehler vermeiden
- Vor dem Buchen immer `Briefpapier`, `Kunde`, `Belegdatum` und (bei Rechnungstypen) `Zahlungsziel` prüfen.
- Bei Zeiträumen Start und Ende vollständig setzen.
- Für Portalfreigabe prüfen, ob Belegstatus nicht mehr `Entwurf` ist.

View File

@@ -0,0 +1,9 @@
# Frontend-Funktionen
Diese Kategorie enthält die Bedienung der einzelnen Seiten im Web-Frontend.
## Enthaltene Inhalte
- Vollständige Seitenübersicht mit erkannten Eingabefeldern: `alle-seiten-und-felder.md`
- Detaillierte Anleitung Ausgangsbeleg-Editor: `ausgangsbelege-editor.md`
- Detaillierte Anleitung Serienrechnungen: `serienrechnungen.md`

View File

@@ -0,0 +1,41 @@
# Serienrechnungen
Seite: `/createDocument/serialInvoice`
Diese Seite verwaltet Vorlagen für Serienrechnungen und erlaubt die manuelle Ausführung von Rechnungsläufen.
## Oberer Bereich
- `Suche`: Filtert die Vorlagenliste.
- `Ausführungen`: Öffnet die Übersicht bestehender Ausführungsläufe.
- `Ausführen`: Startet den Dialog zur manuellen Ausführung.
- `+ Serienrechnung`: Öffnet den Editor zur Anlage einer neuen Serienrechnungsvorlage.
## Filterbereich
- `Filter`: Mehrfachfilter für die Tabellenansicht (je nach verfügbarer Konfiguration).
## Dialog: Serienrechnungen manuell ausführen
- `Ausführungsdatum (Belegdatum)`: Dokumentdatum für den Lauf; beeinflusst Leistungszeitraum laut Konfiguration.
- `Heute`: Setzt das Ausführungsdatum auf den aktuellen Tag.
- `Kunde oder Vertrag suchen`: Freitextsuche innerhalb der Vorlagenliste.
- `Intervall`: Filtert Vorlagen nach Ausführungsrhythmus.
- `Alle auswählen`: Markiert alle sichtbaren Vorlagen.
- `Keine`: Entfernt die Auswahl.
- `Checkbox je Zeile`: Wählt einzelne Vorlagen aus.
- `Ausführen`: Startet den Lauf für die ausgewählten Vorlagen.
## Tabellenspalten (typisch)
- `Typ`: Belegtyp der Vorlage.
- `Partner`: Kunde der Vorlage.
- `Betrag`: Errechneter Vorlagenbetrag.
- `Intervall`: Ausführungsrhythmus.
- `Vertrag`: Zugeordneter Vertrag.
- `Objekt`: Zugeordnetes Objekt.
## Laufende Ausführungen
- `Fertigstellen`: Schließt einen laufenden Ausführungsvorgang ab.

View File

@@ -0,0 +1,8 @@
# Bedienung
Diese Sektion beschreibt die Nutzung der Software aus Anwendersicht.
## Bereiche
- Frontend-Funktionen je Seite: `frontend/README.md`
- Detaillierte Feld-Erklärungen: z. B. `frontend/ausgangsbelege-editor.md`

View File

@@ -1,7 +1,7 @@
---
seo:
title: FEDEO Dokumentation
description: Zentrale, versionierte Funktionsdokumentation für FEDEO.
title: FEDEO Bedienungsanleitung
description: Nutzerorientierte Bedienungsanleitung für alle zentralen Funktionen in FEDEO.
---
::u-page-hero{class="dark:bg-gradient-to-b from-neutral-900 to-neutral-950"}
@@ -9,99 +9,56 @@ seo:
orientation: horizontal
---
#title
FEDEO [Dokumentation]{.text-primary}
FEDEO [Bedienungsanleitung]{.text-primary}
#description
Alle Funktionen von Backend, Web und Mobile an einem Ort. Versioniert, durchsuchbar und auf Basis von Nuxt UI + Nuxt Content aufgebaut.
Diese Dokumentation ist als praktische Anleitung für Anwenderinnen und Anwender der FEDEO-Software aufgebaut.
#links
:::u-button
---
to: /funktionen
to: /bedienung
size: xl
trailing-icon: i-lucide-arrow-right
---
Zu den Funktionen
Zur Bedienungsanleitung
:::
:::u-button
---
icon: i-simple-icons-github
to: /bedienung/frontend
size: xl
color: neutral
variant: outline
size: xl
to: https://git.federspiel.tech/flfeders/FEDEO
target: _blank
---
Repository öffnen
:::
#default
:::prose-pre
---
code: |
node docs/scripts/sync-funktionsdoku.mjs
filename: docs-sync.sh
---
```bash [docs-sync.sh]
node docs/scripts/sync-funktionsdoku.mjs
```
Frontend-Funktionen
:::
::
::u-page-section{class="dark:bg-neutral-950"}
#title
Struktur der Dokumentation
Inhalte
#features
:::u-page-feature
---
icon: i-lucide-layers
icon: i-lucide-layout-dashboard
---
#title
Funktionskatalog
Frontend-Seiten
#description
Technische Übersichten für Backend-API, Web-Frontend und Mobile-App.
Übersicht aller Seitenfunktionen inklusive Eingabefelder und deren Bedeutung.
:::
:::u-page-feature
---
icon: i-lucide-shield-check
icon: i-lucide-file-text
---
#title
Wartungsprozess
Praxisnahe Feld-Erklärungen
#description
Klarer Ablauf, damit Funktionsänderungen immer dokumentiert bleiben.
:::
:::u-page-feature
---
icon: i-lucide-git-branch
---
#title
Versionierung
#description
Änderungen an der Dokumentation sind nachvollziehbar versioniert.
Für zentrale Masken wie den Ausgangsbeleg-Editor werden die Felder konkret erläutert.
:::
::
::u-page-section{class="dark:bg-gradient-to-b from-neutral-950 to-neutral-900"}
:::u-page-c-t-a
---
links:
- label: Funktionsübersicht öffnen
to: '/funktionen/uebersicht'
trailingIcon: i-lucide-arrow-right
- label: Versionshistorie
to: '/versionen/docs-versionen'
variant: subtle
icon: i-lucide-history
title: Bereit für die tägliche Doku-Arbeit?
description: Nutze die technische Übersicht für Änderungen und halte die Dokumentation mit einem festen Sync-Workflow aktuell.
class: dark:bg-neutral-950
---
::

View File

@@ -1,35 +0,0 @@
# Dokumentationsprozess
## Zweck
Dieser Prozess stellt sicher, dass die Funktionsdokumentation bei jeder Änderung aktuell bleibt.
## Verbindlicher Ablauf bei Funktionsänderungen
1. Funktion implementieren oder ändern
2. Technische Doku synchronisieren:
```bash
node docs/scripts/sync-funktionsdoku.mjs
```
3. Fachliche Beschreibung in `docs/funktionen/uebersicht.md` ergänzen, falls ein neuer Bereich entsteht
4. Neue Doku-Version in `docs/versionen/docs-versionen.md` eintragen
5. Code und Doku gemeinsam committen
## Was als Funktionsänderung gilt
- Neue API-Route oder geänderte API-Route
- Neue Web-Seite oder geänderte Seitenstruktur
- Neuer Mobile-Screen oder geänderte Navigationsstruktur
- Größere fachliche Änderung in bestehenden Modulen
## Qualitätsregeln
- Automatisch erzeugte Dateien nicht manuell pflegen
- Fachliche Begriffe konsistent halten
- Jede Doku-Version erhält Datum, Änderungszusammenfassung und Bezug zu Commits
## CI-Empfehlung
Optional kann in CI geprüft werden, ob die generierten Doku-Dateien aktuell sind (z. B. per Diff nach Skriptlauf), damit keine Funktionsänderung ohne Doku-Update gemerged wird.

File diff suppressed because it is too large Load Diff

View File

@@ -14,6 +14,7 @@
"@nuxt/content": "^3.12.0",
"@nuxt/image": "^2.0.0",
"@nuxt/ui": "^4.6.1",
"better-sqlite3": "^12.9.0",
"nuxt": "^4.4.2"
},
"devDependencies": {