保持雙語文件對齊
公開使用者指南透過相對路徑配對:
docs/en/<relative-path>
docs/ja/<relative-path>
英文文件發布於 /;日文文件發布於 /ja/。日文仍然是新產品說明的實質撰寫來源,但在任一語言中進行編輯時,不得在未告知的情況下讓其對應語言版本出現不同的行為、命令、所有權邊界、警告或導航。
範圍
將此工作流程應用於兩個語言根目錄下的 index.md 和 guide/**/*.md。
docs/en/reference/ 特意僅保留英文。兩個語言根目錄之外的內部架構、決策、儲存庫、貢獻者和前瞻測試文件不屬於翻譯配對。
工作流程
- 檢查請求的變更和當前的 Git diff。識別每個受影響的公開頁面及其相同相對路徑的對應頁面。
- 完整閱讀兩個頁面。當日文內容被建立、編輯或為提高可讀性進行審查時,也請閱讀日文風格參考。當編輯改變產品行為、命令、路徑或所有權時,請驗證當前來源或已接受的決策,而不是翻譯假設。
- 保留含義、資訊架構、範例、警告和連結目標,但要為每個受眾撰寫自然的文件,而不是逐句翻譯。當含義或資訊結構發生變化時,編輯兩個對應頁面。對於純粹的日文措辭改進,請檢查英文對應頁面,但不要在英文頁面的含義和結構已一致時製造英文編輯。
- 如果一個對應頁面不存在,請建立它。如果一個頁面刻意針對特定語言,請確認它在配對範圍之外,或獲得明確的推遲決策;報告推遲及其追蹤位置。在未提及偏離時,不要將雙語變更視為完成。
- 對於移動或刪除,對兩個樹套用相同的相對路徑變更,並更新
mkdocs.yml、入站連結、貢獻者指南以及嵌入在程式碼或測試中的任何公開 URL。
驗證
從儲存庫根目錄執行:
python -m mkdocs build --strict
git diff --check
確認生成的英文和日文頁面存在於對應路徑,且其語言選擇器連結相互指向。當公開 URL 是 CLI 合約時,也更新其來源、聚焦測試和已接受的決策,然後執行聚焦測試和 python scripts/check_decisions.py。
報告已檢查和變更的頁面配對、在語意比較後刻意保持不變的對應頁面、任何其他例外情況以及驗證結果。