實戰範例：翻譯 README

這份範例帶你一步步將 Markdown README 翻譯成其他語言，所有結構元素都保持完整。

基本用法

yaku --to zh-TW -f README.md -o README.zh-TW.md

yaku 偵測到 .md 副檔名後，會套用格式感知翻譯：標題、程式碼區塊、連結、圖片和 front matter 保持不動，只翻譯文字內容。

逐步教學

1. 建立術語表（選用但建議）

在專案根目錄建立 .yaku-glossary.yaml，鎖定關鍵用語：

zh-TW:
  MyProject: ~           # 保留專案名稱
  GitHub: ~
  npm: ~
  MIT License: MIT 授權條款

2. 翻譯

yaku --to zh-TW -f README.md -o README.zh-TW.md

3. 檢查輸出

確認以下幾點：

• 標題層級是否正確？
• 程式碼區塊是否未被修改？
• 連結網址和圖片路徑是否完整？
• 術語表中的用語是否翻譯正確？

4. 翻譯成其他語言

yaku --to ja -f README.md -o README.ja.md
yaku --to ko -f README.md -o README.ko.md

加上情境提升品質

如果你的 README 涵蓋特定領域，加上情境說明：

yaku --to zh-TW \
  --context "CLI developer tool documentation" \
  -f README.md -o README.zh-TW.md

用腳本自動化

將 README 翻譯成多種語言：

#!/bin/bash
LANGUAGES=("zh-TW" "ja" "ko" "fr" "de")

for lang in "${LANGUAGES[@]}"; do
  yaku --to "$lang" -f README.md -o "README.${lang}.md"
  echo "已翻譯成 $lang"
done

小技巧

• 務必檢查輸出。 LLM 翻譯品質不錯但並非完美。請確認品牌名稱、技術用語和慣用語的正確性。
• 使用術語表確保一致性。 如果你在更新 README 後重新翻譯，術語表能確保每次使用相同的翻譯。
• 從原始檔案翻譯。 一律從英文（或原始語言）的 README 翻譯，而不是從另一個翻譯版本 — 避免錯誤層層累積。