保持双语文档对齐
公共用户指南按相对路径配对:
docs/en/<relative-path>
docs/ja/<relative-path>
英语版本发布于 /;日语版本发布于 /ja/。日语是新产品说明的实际创作源语言,但当任一语言发生编辑时,不得静默地使另一语言在行为、命令、所有权边界、警告或导航上出现差异。
范围
将此工作流应用于两种语言根目录下的 index.md 和 guide/**/*.md。docs/en/reference/ 有意仅保留英语。两种语言根目录之外的内部架构、决策、仓库、贡献者和前瞻性测试文档不属于翻译配对范围。
工作流程
- 检查请求的变更和当前的 Git 差异。识别所有受影响的公共页面及其相同相对路径的对应页面。
- 完整阅读两个页面。当日语内容被创建、编辑或进行可读性审查时,同时阅读日语风格参考。当编辑更改了产品行为、命令、路径或所有权时,请验证当前源代码或已接受的决策,而不是翻译假设。
- 保留含义、信息架构、示例、警告和链接目标,但为每个受众撰写自然的文档,而不是逐句翻译。当含义或信息结构发生变化时,同时编辑两个对应页面。对于仅日语用词的改进,检查英语对应页面,但当其含义和结构已一致时,不要人为制造英语编辑。
- 如果某个对应页面不存在,则创建它。如果某个页面有意仅使用特定语言,请确认其不在配对范围内,或获得明确的推迟决策;报告该推迟及其跟踪位置。在漂移未被提及的情况下,不要将双语变更视为完成。
- 对于移动或删除操作,对两个树应用相同的相对路径更改,并更新
mkdocs.yml、入站链接、贡献者指南以及嵌入在代码或测试中的任何公共 URL。
验证
从仓库根目录运行:
python -m mkdocs build --strict
git diff --check
确认生成的英语和日语页面存在于对应路径,并且它们的语言选择器链接相互指向。当公共 URL 是 CLI 契约时,同时更新其源代码、焦点测试和已接受的决策,然后运行焦点测试和 python scripts/check_decisions.py。
报告检查并更改的页面对、在语义比较后有意保持不变的对应页面、任何其他异常以及验证结果。