Förbättra den här manualen¶
Handbokens källtext lagras som Markdown i katalogen docs/, och webbplatsen byggs med MkDocs.
Lokal förhandsvisning¶
Skapa en virtuell miljö och installera dokumentationsberoendena:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Öppna den lokala adressen som skrivits ut av MkDocs. Förhandsgranskningen återskapas när en källfil ändras.
Validera webbplatsen¶
Innan du öppnar en pull-begäran:
Den strikta builden rapporterar saknade navigeringsposter, ogiltiga länkar som upptäckts av MkDocs och konfigurationsvarningar.
Skrivprinciper¶
- Skriv för en specifik uppgift och målgrupp.
- Ange versionen MRBS när beteendet är versionsspecifikt.
- Föredrar testade exempel framför uttömmande listor.
- Inkludera aldrig riktiga referenser eller privat bokningsdata.
- Länka relaterade uppgifter istället för att duplicera stora avsnitt.
- Uppdatera alla tillgängliga översättningar när det är praktiskt möjligt.
Översättningar¶
Engelska är referenstexten. Tyska, franska och spanska sidor använder samma relativa sökväg med ett språksuffix:
När en översättning saknas faller webbplatsen tillbaka till engelska. En översättning bör bevara kod, inställningsnamn, varningar och länkar samtidigt som naturlig terminologi används på målspråket.
Omfattning¶
Detta dokumentationsträd är inriktat på MRBS 1.12.2. Ändringar som beskriver en senare version måste uppdatera det synliga versionsomfånget eller utvecklas i dokumentationsuppsättningen för den versionen.