Perbaiki manual ini¶
Manual ini dikekalkan sebagai Markdown dalam direktori docs/ dan dibina dengan MkDocs.
Pratonton setempat¶
Cipta persekitaran maya dan pasang kebergantungan dokumentasi:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Buka alamat setempat yang dicetak oleh MkDocs. Pratonton dibina semula apabila fail sumber berubah.
Sahkan tapak¶
Sebelum membuka permintaan tarik:
Binaan ketat melaporkan entri navigasi yang hilang, pautan tidak sah yang dikesan oleh MkDocs dan amaran konfigurasi.
Prinsip penulisan¶
- Tulis untuk tugas dan penonton tertentu.
- Nyatakan versi MRBS apabila tingkah laku adalah khusus keluaran.
- Lebih suka contoh yang diuji berbanding senarai lengkap.
- Jangan sekali-kali sertakan bukti kelayakan sebenar atau data tempahan peribadi.
- Pautkan tugas berkaitan dan bukannya pendua bahagian besar.
- Kemas kini semua terjemahan yang tersedia apabila praktikal.
Terjemahan¶
Bahasa Inggeris adalah teks rujukan. Halaman Jerman, Perancis dan Sepanyol menggunakan laluan relatif yang sama dengan akhiran setempat:
Apabila terjemahan tiada, tapak itu akan kembali kepada bahasa Inggeris. Terjemahan harus mengekalkan kod, menetapkan nama, amaran dan pautan semasa menggunakan istilah semula jadi dalam bahasa sasaran.
Skop¶
Pokok dokumentasi ini menyasarkan MRBS 1.12.2. Perubahan yang menerangkan keluaran kemudian mesti mengemas kini skop versi yang boleh dilihat atau dibangunkan dalam set dokumentasi untuk keluaran tersebut.