Dieses Handbuch verbessern¶
Das Handbuch liegt als Markdown unter docs/ und wird mit MkDocs gebaut.
Lokale Vorschau¶
Virtuelle Umgebung anlegen und Abhängigkeiten installieren:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Die von MkDocs ausgegebene Adresse öffnen. Änderungen lösen einen Neubau aus.
Website prüfen¶
Vor einem Pull Request:
Der strikte Build meldet fehlende Navigationseinträge, erkannte ungültige Links und Konfigurationswarnungen.
Schreibprinzipien¶
- Für eine konkrete Aufgabe und Zielgruppe schreiben.
- Bei versionsabhängigem Verhalten MRBS-Version nennen.
- Geprüfte Beispiele gegenüber endlosen Listen bevorzugen.
- Keine echten Zugangsdaten oder privaten Buchungsdaten verwenden.
- Verwandte Aufgaben verlinken statt große Abschnitte zu duplizieren.
- Alle Übersetzungen gemeinsam aktualisieren.
Übersetzungen¶
Englisch ist die Referenz. Deutsch, Französisch und Spanisch verwenden dasselbe relative Ziel mit Sprachsuffix:
Fehlt eine Übersetzung, fällt die Website auf Englisch zurück. Eine Übersetzung erhält Code, Einstellungsnamen, Warnungen und Links und verwendet natürliche Fachbegriffe der Zielsprache.
Umfang¶
Diese Dokumentation beschreibt MRBS 1.12.2. Änderungen für spätere Versionen müssen den sichtbaren Versionsumfang aktualisieren oder in der passenden Dokumentation entwickelt werden.