Zur Übersichtlichkeit wird mit einem vorgeschalteten Emoji kategorisiert:
| EMOJI | Kategorie |
|---|---|
| 🖥️ | GUI |
| 📝 | Task / Workflow |
| 🔧 | Tool |
| 🗃️ | Entität |
| 🧩, 📊 | Grundlagen, Erklärungen |
Hier werden allgemeine Funktionen, Oberfläche und Bedienlogik erklärt – ideal als Einstieg für neue Nutzer:innen.
Inhalte:
Jede Entität bekommt eine eigene, gleich strukturierte Seite mit Felderklärung, Screenshots und Beispielen. Pflichtfelder und Abhängigkeiten sollten hervorgehoben werden.
Empfohlene Struktur pro Entität:
Kurze Beschreibung: Wofür dient die Entität?
Pflichtfelder (🟨 = Pflichtfeld, 🔧 = Eingabe nötig)
Screenshot mit Platzhaltern
Verknüpfungen zu anderen Entitäten
Hinweise zu häufigen Fehlern
Best Practices oder Tipps
Hier werden typische Abläufe beschrieben – Schritt für Schritt, mit Screenshots, Verantwortlichkeiten und Tipps.
Empfohlene Struktur:
Beispiele:
Einführung: Was ist flexRM und wofür wird es genutzt?
Aufbau: Entitäten, Beziehungen, Stammdaten, Bewegungsdaten
Benutzeroberfläche, Navigation & Filter
Basis Angebot (ab Version 6.0.0)
Vertrag (Anschluss- und Wärmeliefervertrag)
Vertragszusatz: Anzahlungsvereinbarung
Übergabestation mit Zähler verbinden
Felder in der Vorlage + Prüfliste zur Erstellung einer vollständigen Rechnungsvorlage
Tarife, Produkte und Preise anlegen
Logische Gesamtstruktur der Abrechnung
Berechnung des neuen Abschlagsbetrags