Was ist SpeamCore?
SpeamCore ist die Lifecycle-Plattform der Speam GmbH für Errichter, Wartungsbetriebe und Betreiber im vorbeugenden Brandschutz. Sie buendelt Stammdaten, Auftragsmanagement, Projektsteuerung, Wartung, Finanzen und die Integration der SpeamBox-Hardware in einer einzigen Anwendung.
Wer liest diese Doku
- Endanwender in Brandschutz-Fachfirmen — Sie steuern damit ihren Tagesbetrieb.
- Administratoren, die Mandanten, Rollen und Schnittstellen einrichten.
- KIera AI und Claude (über RAG) — die Doku ist maschinenlesbar strukturiert, damit KI-Assistenten Endanwender praezise anleiten koennen.
Wie diese Dokumentation aufgebaut ist
Die Doku ist routen-zentriert. Jede Funktionsseite spiegelt 1:1 eine echte SpeamCore-Route:
| App-Route | Doku-URL |
|---|---|
app.speamcore.com/customers | docs.speamcore.com/customers |
app.speamcore.com/purchase-documents | docs.speamcore.com/purchase-documents |
app.speamcore.com/workorders | docs.speamcore.com/workorders |
Damit findet sich jeder Endanwender intuitiv zurecht und KIera kann via Endpoint-Lookup zuverlaessig die richtige Hilfeseite ziehen.
Daneben gibt es zwei Querschnitt-Sektionen, die in jeder Funktionsseite verlinkt werden:
- Grundlagen — wiederverwendbare UI-Patterns wie Filter, Tabellen, HTML-Editor, Suche, Bulk-Aktionen. Werden in Routen-Seiten referenziert, nicht dupliziert. Einstieg z. B. über Glossar oder FAQ.
- Konzepte — Domaenen-Konzepte wie Berechtigungen (CASL), Mandanten, SpeamID/Keycloak, Anlage vs. Objekt, Belegpolymorphismus. Einstieg über Geschäftsprozess-Übersicht oder Workflow-Diagramme.
Voraussetzungen für den Einstieg
- Aktiver SpeamID-Zugang (Keycloak-basiert) Ihres Unternehmens.
- Aktueller Browser (Chrome, Edge, Firefox, Safari — letzte zwei Hauptversionen).
- Berechtigungen Ihres Administrators für die jeweils benötigten Module.
Erste Schritte
- Ersteinrichtung (Setup-Wizard) — Mandant in 12 Schritten einrichten.
- Berechtigungen verstehen — wie Rollen und CASL zusammenspielen.
- Bestellbelege als Routen-Beispiel — Vorlage für alle weiteren Funktionsseiten.
Wie die Doku aktuell bleibt
Die Doku liegt im selben Repo-Verbund wie SpeamCore. Jeder Merge Request, der eine Funktion ändert, muss die Doku mit aktualisieren — siehe Beitragsleitfaden. Eine geplante CI-Pipeline vergleicht dafür Routen und CASL-Subjects im Code mit den Frontmatter-Feldern der Doku-Seiten und meldet Drift automatisch.