改进本手册¶
本手册的 Markdown 源文件保存在 docs/ 目录中，网站则使用 MkDocs 构建。
本地预览¶
创建虚拟环境并安装文档依赖项：
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
打开MkDocs打印的本地地址。当源文件更改时，预览会重建。
验证网站¶
在打开拉取请求之前：
严格模式构建会报告缺失的导航条目、MkDocs 检测到的无效链接以及配置警告。
写作原则¶
- 为特定任务和受众写作。
- 当行为特定于版本时，请注明 MRBS 版本。
- 比起详尽的列表，更喜欢经过测试的示例。
- 切勿包含真实凭证或私人预订数据。
- 链接相关的任务而不是重复大的部分。
- 实用时更新所有可用的翻译。
翻译¶
英文为参考文本。德语、法语和西班牙语页面使用相同的相对路径和区域设置后缀：
当翻译缺失时，网站会回退为英语。翻译应保留代码、设置名称、警告和链接，同时使用目标语言的自然术语。
适用范围¶
此文档树的目标是 MRBS 1.12.2。描述更高版本的更改必须更新可见版本范围或在该版本的文档集中进行开发。