レシピ: READMEの翻訳

このレシピでは、MarkdownのREADMEを別の言語に翻訳する手順を、すべての構造要素を保持しながら説明します。

基本的なアプローチ

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

yakuは.md拡張子を検出し、Markdown対応翻訳を適用します。見出し、コードブロック、リンク、画像、フロントマターはそのまま保持されます。散文のみが翻訳されます。

ステップバイステップ

1. 用語集の設定（任意だが推奨）

プロジェクトルートに.yaku-glossary.yamlを作成して、重要な用語を固定します：

ja:
  MyProject: ~           # プロジェクト名を保持
  GitHub: ~
  npm: ~
  MIT License: MITライセンス

2. 翻訳

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

3. 出力の確認

以下の点をチェックしてください：

• 見出しのレベルは正しいか？
• コードブロックは変更されていないか？
• リンクURLや画像パスはそのままか？
• 用語集の用語は正しく翻訳されているか？

4. 追加の言語に翻訳

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

コンテキストの追加で品質向上

READMEが特定のドメインを扱う場合、コンテキストを追加します：

yaku --to ja \
  --context "CLI開発ツールのドキュメント" \
  -f README.md -o README.ja.md

スクリプトで自動化

READMEを複数の言語に翻訳します：

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

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

ヒント

• 出力は必ず確認する。 LLM翻訳は優秀ですが完璧ではありません。ブランド名、技術用語、慣用表現を確認してください。
• 一貫性のために用語集を使う。 READMEの更新後に再翻訳する場合、用語集が毎回同じ用語の使用を保証します。
• ソースファイルから翻訳する。 常に英語（または元の言語）のREADMEから翻訳し、別の翻訳版からは翻訳しないでください — 誤りの蓄積を避けられます。