Verbeter deze handleiding¶
De handleiding staat als Markdown in de map docs/ en wordt met MkDocs gebouwd.
Lokaal voorbeeld¶
Creëer een virtuele omgeving en installeer de documentatie-afhankelijkheden:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Open het lokale adres dat is afgedrukt door MkDocs. Het voorbeeld wordt opnieuw opgebouwd wanneer een bronbestand verandert.
Valideer de site¶
Voordat u een pull-aanvraag opent:
De strikte build rapporteert ontbrekende navigatie-items, ongeldige links gedetecteerd door MkDocs en configuratiewaarschuwingen.
Principes van schrijven¶
- Schrijf voor een specifieke taak en doelgroep.
- Geef de versie MRBS op als het gedrag releasespecifiek is.
- Geef de voorkeur aan geteste voorbeelden boven uitputtende lijsten.
- Voeg nooit echte inloggegevens of privéboekingsgegevens toe.
- Koppel gerelateerde taken in plaats van grote secties te dupliceren.
- Update alle beschikbare vertalingen wanneer dit praktisch mogelijk is.
Vertalingen¶
Engels is de referentietekst. Duitse, Franse en Spaanse pagina's gebruiken hetzelfde relatieve pad met een locale-achtervoegsel:
Wanneer een vertaling ontbreekt, valt de site terug naar het Engels. Een vertaling moet code, namen, waarschuwingen en links behouden, terwijl natuurlijke terminologie in de doeltaal wordt gebruikt.
Reikwijdte¶
Deze documentatieboom richt zich op MRBS 1.12.2. Wijzigingen die een latere release beschrijven, moeten het zichtbare versiebereik bijwerken of worden ontwikkeld in de documentatieset voor die release.