AI Translations
Docsbook が Claude AI を使用してドキュメントを自動的に翻訳する方法。
仕組み
- 翻訳設定で言語を有効にします。
- Docsbook は GitHub から Markdown ファイルをフェッチします。
- 各ファイルは Claude (Anthropic 製) に翻訳のために送信されます。
- 翻訳されたページは高速配信のためにキャッシュされます。
- GitHub に更新をプッシュすると、変更されたページのみが再翻訳されます。
手作業は不要です。メンテナンスする翻訳ファイルも、YAML キーもありません。
何が翻訳されるか
| 翻訳される | 翻訳されない |
|---|---|
| 本文 | コードブロック |
| 見出し | インラインコード (like this) |
| テーブル | URLとリンク |
| 画像の代替テキスト | ファイルパス |
| サイドバーのナビゲーションラベル | 技術的な識別子 |
| ページタイトルとメタディスクリプション | — |
コードは意図的に元の言語のままにされています。読者のロケールに関係なく、一貫性を保つ必要があります。
翻訳キャッシュ
翻訳は、ページごとに言語ごとにキャッシュされ、GitHub上のファイルのコンテンツハッシュに基づいてキーが設定されます。
- コンテンツの変更後の初回訪問では、再翻訳がトリガーされます(数秒)。
- それ以降のすべての訪問では、キャッシュされたバージョンが即座に提供されます。
- 言語を一時的に無効にしても、キャッシュされた翻訳は保持されます。
つまり、以前に有効になっていた言語を再度有効にすると、即座に有効になり、再翻訳は不要です。
翻訳の品質
Claudeは高品質な技術ドキュメントの翻訳を生成します。
最適な用途:
- ステップバイステップガイド
- APIドキュメント
- FAQ
- 構成リファレンス
手動レビューが必要な場合:
- ブランド固有の用語
- 文化的参照やイディオム
- 高度に専門的な専門用語
より良いAI翻訳のための執筆のヒント
明確なソースコンテンツは、より良い翻訳をもたらします。次のガイドラインに従ってください。
- 短く、直接的な文を使用してください。 長い複合文は翻訳でニュアンスを失います。
- 慣用句を避けてください。 「It's a piece of cake」は文字通りの翻訳になりません。「It's simple」と言う代わりに。
- ISOの日付形式を使用してください。
2024-03-25と記述し、「March 25th」とは記述しないでください。日付は地域によって解釈が異なります。 - コードコメントは英語のままにしてください。 翻訳から除外されますが、すべての開発者が読めるようにする必要があります。
- 用語を統一してください。 ある場所で何かを「workspace」と呼んだ場合、別の場所で「project」と呼んではいけません。
翻訳のオーバーヘッドなしでグローバル展開。 翻訳を有効にする →
関連項目: 翻訳設定 →