Dokumentation
Wo welche Dokumentation lebt
Schneespur ist an mehreren Orten dokumentiert — bewusst. Diese Seite zeigt, wo Sie was finden, ohne dass Wissen doppelt gepflegt wird.
Vier Dokumentations-Orte
Jeder Ort beantwortet eine andere Art Frage am besten.
-
In der Software selbst
Schneespur enthält eine kontextsensitive Hilfe — auf jeder Admin-Seite erklärt ein eingeblendeter Hilfe-Bereich, was die aktuelle Maske tut. Das ist die zuverlässigste Dokumentationsquelle: sie ist exakt zur installierten Version passend.
Verfügbar nach der Installation
-
Auf dieser Website
Die Seiten unter /funktionen erklären jede Kernfunktion einzeln; /installation führt durch die Erst-Einrichtung; /faq sammelt die wiederkehrenden Fragen aus dem Alltag. Diese Seiten beschreiben das aktuelle Funktions-Konzept — nicht eine spezifische Version.
Zur Funktionsübersicht -
Im Quellcode-Repository
Auf GitHub liegen Lizenz (AGPLv3), Changelog, technische README-Hinweise und der vollständige Quellcode. Für Entwickler ist das die maßgebliche Referenz — etwa für Modifikationen oder zur Code-Prüfung.
Repository öffnen -
Im Issue-Tracker
Bekannte Bugs, geplante Verbesserungen und Diskussionen sind öffentlich auf GitHub. Wer eine konkrete Frage hat, die nicht in der FAQ steht, findet hier oft schon eine Antwort von anderen Anwendern.
Issues durchsuchen
Themen-Übersicht
Die wichtigsten Themenbereiche auf der Website — sortiert nach Einstiegs-Reihenfolge.
-
Erste Schritte
Installation auf gewöhnlichem Webhosting, Einrichtung des ersten Admin-Kontos, Cron-Job und OwnTracks.
-
Was die Software tut
Elf Kernfunktionen gruppiert nach Tagesablauf — Erfassung, Nachweise, Verwaltung.
-
Rechtlicher Hintergrund
Verkehrssicherungspflicht im Winterdienst, was im Haftungsfall typischerweise verlangt wird.
-
Self-Hosting verstehen
Warum Schneespur auf eigenem Webhosting läuft, was das technisch bedeutet, welche Vorteile daraus folgen.
-
Open Source und Lizenz
AGPLv3 erklärt, Transparenz-Argumente, Hinweise für Modifikationen.
-
DSGVO-Werkzeuge
Anonymisierung, Aufbewahrungsfristen, Datenexport und Datenschutzbelehrung.
-
Auto-Updates verstehen
Wie Signaturen funktionieren, was bei einem Fehlschlag passiert, warum nichts automatisch installiert wird.
-
Häufige Fragen
Antworten auf wiederkehrende Fragen aus Installation, Betrieb, Datenschutz und Lizenz.
Was die Dokumentation nicht ist
-
Kein Wiki
Es gibt bewusst kein gemeinschaftlich gepflegtes Wiki neben dem Repository — die Dokumentations-Landschaft soll überschaubar bleiben. Beiträge laufen über GitHub-Pull-Requests.
-
Kein versteckter Premium-Bereich
Die gesamte Dokumentation ist öffentlich. Keine „Dokumentation für zahlende Kunden", kein paywalled Wissen.
-
Keine API-Dokumentation (heute)
Eine öffentliche REST-API steht in der Roadmap, ist aber noch nicht verfügbar. Sobald sie es ist, gibt es eine dedizierte Referenz.
Fragen zur Dokumentation
- Wo finde ich die schnellste Antwort auf eine konkrete Frage?
- In der integrierten Hilfe der Software, wenn Sie schon installiert haben. Sonst: die FAQ-Seite — sie deckt die häufigen Themen ab.
- Gibt es eine PDF-Version der Dokumentation?
- Nein. Die Website ist die aktuelle Referenz, das Repository die technische Referenz. Eine statische PDF würde schnell veralten und falsche Sicherheit erzeugen.
- Kann ich zur Dokumentation beitragen?
- Ja. Korrekturen und Ergänzungen laufen über Pull-Requests im GitHub-Repository. Bei umfangreicheren Beiträgen vorab kurz per Issue abstimmen.
- Welche Sprachen sind verfügbar?
- Diese Website ist Deutsch. Eine englische Schwesterseite gibt es unter wintertrace.com — die Substanz ist dort identisch, die Tonalität international gehalten.