Forbedr denne manual¶
Manualen vedligeholdes som Markdown i mappen docs/ og bygges med MkDocs.
Lokal forhåndsvisning¶
Opret et virtuelt miljø og installer dokumentationsafhængighederne:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Åbn den lokale adresse, som MkDocs viser. Forhåndsvisningen genopbygges, når en kildefil ændres.
Valider webstedet¶
Før du opretter en pull request:
Det strenge build rapporterer manglende navigationselementer, ugyldige links, som MkDocs finder, og advarsler i konfigurationen.
Skriveprincipper¶
- Skriv til en bestemt opgave og målgruppe.
- Angiv MRBS-versionen, når adfærd er udgivelsesspecifik.
- Foretræk testede eksempler frem for udtømmende lister.
- Inkluder aldrig ægte legitimationsoplysninger eller private bookingdata.
- Link relaterede opgaver i stedet for at duplikere store sektioner.
- Opdater alle tilgængelige oversættelser, når det er praktisk muligt.
Oversættelser¶
Engelsk er referenceteksten. Oversatte sider bruger den samme relative sti med en sprogkode som suffiks, for eksempel:
Hvis en oversættelse mangler, vises siden på engelsk. En oversættelse skal bevare kode, indstillingsnavne, advarsler og links og samtidig bruge naturlig terminologi på målsproget.
Omfang¶
Dette dokumentationstræ er målrettet MRBS 1.12.2. Ændringer, der beskriver en senere udgivelse, skal opdatere det synlige versionsomfang eller udvikles i dokumentationssættet for den pågældende udgivelse.