跳轉至

改進本手冊

本手冊的 Markdown 原始檔保存在 docs/ 目錄中,網站則使用 MkDocs 建置。

本地預覽

建立虛擬環境並安裝文件依賴項:

python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve

開啟MkDocs列印的本地地址。當來源檔案更改時,預覽會重建。

驗證網站

在打開拉取請求之前:

mkdocs build --strict

嚴格模式建置會報告缺少的導覽項目、MkDocs 偵測到的無效連結以及設定警告。

寫作原則

  • 為特定任務和受眾寫作。
  • 當行為特定於版本時,請註明 MRBS 版本。
  • 比起詳盡的列表,更喜歡經過測試的範例。
  • 切勿包含真實憑證或私人預訂資料。
  • 連結相關的任務而不是重複大的部分。
  • 實用時更新所有可用的翻譯。

翻譯

英文為參考文。德語、法語和西班牙語頁面使用相同的相對路徑和區域設定後綴:

installation.md
installation.de.md
installation.fr.md
installation.es.md

當翻譯缺失時,網站會回退為英文。翻譯應保留程式碼、設定名稱、警告和鏈接,同時使用目標語言的自然術語。

適用範圍

此文檔樹的目標是 MRBS 1.12.2。描述更高版本的變更必須更新可見版本範圍或在該版本的文件集中進行開發。