mcpField
M
multi-lang-readme

multi-lang-readme

github.com/yangsonhungドキュメント1860 回インストール12 週間前に更新
リポジトリ

multi-lang-readme について

既存の README を複数言語に翻訳するスキルです。プロジェクト文書を多言語で管理するチーム向けで、Markdown の構成、リンク、コードブロックを保ち、言語切り替えリンクを追加します。README 以外の文書翻訳には使いません。

主な機能

  1. 01README の複数言語への翻訳
  2. 02Markdown 構成、リンク、コードブロックの維持
  3. 03言語サフィックス付きファイルの作成
  4. 04言語切り替えリンクの追加・更新
  5. 05ファイル名、リンク先、書式の確認

活用シーン

  1. 01英語と中国語の README セット作成
  2. 02README の日本語など対応言語への翻訳
  3. 03翻訳済み README 間の相互リンク追加

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/yangsonhung/awesome-agent-skills --skill multi-lang-readme

インストール後、Claude Code で/multi-lang-readmeを入力して読み込まれたか確認します。

詳細

多言語 README

概要

既存の README を翻訳し、Markdown の構造、リンク、コードブロック、言語切り替えナビゲーションを維持したまま、多言語の README ファイルを作成します。このワークフローでは、プロジェクトの関連しないドキュメントを書き換えることなく、2言語または多言語の README セットを用意できます。

使用する場面

次のような依頼があった場合に、このスキルを使用します。

  • 2言語の README の作成（たとえば英語＋中国語）
  • 多言語 README の生成
  • 既存の README を1つ以上の対象言語に翻訳
  • README ファイル間で統一された言語切り替えリンクの追加

使用しない場面

次の目的には、このスキルを使用しないでください。

  • README 以外の任意のドキュメントの翻訳
  • 製品要件や法的文書の書き換え
  • README の翻訳に関係しないコンテンツの生成

手順

  1. 翻訳する元の README ファイルを特定します（曖昧な場合はユーザーに確認してください）。
  2. 対象言語と標準とする README の言語を確認します。
  3. Markdown、リンク、コードブロックを維持しながら翻訳します。
  4. 言語サフィックスの規則に従って、翻訳ファイルを作成します。
  5. 各 README の先頭に言語切り替えリンクを追加または更新します。
  6. 最終出力の前に、ファイル名、リンク先、書式を確認します。

対応言語

コード言語
en英語
deドイツ語
ja日本語
ko韓国語
zh-CN中国語

ワークフロー

ステップ 1：README を特定する

元の README を探します。

  • ルートディレクトリで README.md を確認します
  • README ファイルが複数ある場合は、どのファイルを翻訳するかユーザーに確認します
ステップ 2：README の内容を読む

次の内容を含む Markdown 全体を読みます。

  • タイトル
  • バッジ
  • すべてのセクション（機能、インストール、使い方、コントリビューション、ライセンスなど）
  • コードブロック
  • リンク
ステップ 3：対象言語を確認する

翻訳先の言語をユーザーに確認します。特に指定がない場合の前提：

  • README.md は常に標準版として英語にします
  • 現在の README が中国語（または英語以外の言語）の場合、まず英語に翻訳します
  • 英語版を用意した後、依頼に応じて他の言語版を追加します

ユーザーが言語を指定せずに「2言語の README を作成」と依頼した場合：

  • 既存の README をまず英語に翻訳します（README.md を置き換えるか、新しく作成します）
  • 次に中国語版（README.zh-CN.md）を追加します
ステップ 4：AI で翻訳する

次のルールに従って翻訳します。

  • Markdown の書式を維持します
  • コードブロックは変更しません
  • セクションのタイトルを対象言語に翻訳します
  • 内部リンク（相対パス）はそのままにします
  • 外部リンクは、適切であればリンクテキストを対象言語にします
ステップ 5：翻訳版 README を作成する

重要：ユーザーが明示的に別の規則を指定しない限り、README.md は標準の英語版として維持します。

  • 英語：README.md（英語版を作成または置き換え）
  • ドイツ語：README.de.md
  • 日本語：README.ja.md
  • 韓国語：README.ko.md
  • 中国語：README.zh-CN.md

元の README が英語以外で、ユーザーが同意した場合は、元のファイルを英語版の README.md に置き換えます。

ステップ 6：言語切り替えリンクを追加する

元の README の先頭に言語切り替えリンクを追加します。

**English** | [中文](README.zh-CN.md) | [Deutsch](README.de.md) | [日本語](README.ja.md) | [한국어](README.ko.md)

タイトルまたはバッジの下、本文の前に追加します。

ステップ 7：翻訳版 README を更新する

翻訳版 README に対応する相互リンクを追加します。

**[Original](README.md)** | [中文](README.zh-CN.md)

言語コードの参照

en    → no suffix (README.md)
de    → README.de.md
ja    → README.ja.md
ko    → README.ko.md
zh-CN → README.zh-CN.md

よくある依頼

  • 「2言語の README を作成」
  • 「英語版と中国語版の README を作成」
  • 「README を日本語に翻訳」
  • 「README にドイツ語版を追加」
  • 「README.zh-CN.md を追加」

コメント

Markdown 対応