mcpField
U
update-readme

update-readme

github.com/fradser開発59681 回インストール5 週間前に更新
リポジトリ

update-readme について

Update READMEは、英語と簡体字中国語のプロジェクトREADMEを、リポジトリの現状に合わせるためのスキルです。プロジェクトの調査から両言語の文書作成、正確性と整合性の確認までを案内します。

主な機能

  1. 01プロジェクト構成と既存文書の調査
  2. 02一貫したREADME構成の適用
  3. 03英語版と中国語版の作成
  4. 04記載項目とコマンドの確認
  5. 05両ファイルの整合性レビュー

活用シーン

  1. 01プロジェクト変更後の文書更新
  2. 02二言語のREADMEの内容統一
  3. 03リポジトリに基づく構成項目の照合

インストール

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

$npx skills add https://github.com/fradser/dotclaude --skill update-readme

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

同梱ファイルreferences/template.md

詳細

README の更新

README.md（英語、メイン）と README.zh-CN.md（簡体字中国語、サブ）を、プロジェクトの実際の最新の状態に合わせて更新します。どちらのファイルも正確かつ完全で、互いに整合している必要があります。

重要：正確な情報とヘッダー形式

  • 記憶や推測ではなく、実際の情報に基づいて記述してください。README に記載するすべてのスキル／コンポーネントは、執筆時点でリポジトリに存在していなければなりません。記載前に存在を確認してください。
  • すべての README は、以下の「ヘッダー形式」に示す正確な構成（言語切り替えを含む）で始めてください。バッジ、プロジェクト名、説明はプロジェクトに合わせて変更しますが、構成は省略しないでください。
  • 会話内で README の内容をコードブロックとして出力しないでください。Edit または Write ツールを使って、ファイルに直接書き込んでください。

ヘッダー形式（必須）

すべての README は、以下の正確な構成で始めてください。バッジ、プロジェクト名、説明は対象プロジェクトに合わせて変更します。

# <Project Name> ![](https://img.shields.io/badge/<label>-<message>-<color>)

[![<Badge1 Label>](<badge-url>)](<link>) [![<Badge2 Label>](<badge-url>)](<link>)

**English** | [简体中文](README.zh-CN.md)

README.zh-CN.md では、言語切り替えの順序を逆にしてください。

# <Project Name> ![](https://img.shields.io/badge/<label>-<message>-<color>)

[![<Badge1 Label>](<badge-url>)](<link>) [![<Badge2 Label>](<badge-url>)](<link>)

[English](README.md) | **简体中文**

プロジェクトの実態を正しく示すバッジを選んでください。一般的な種類には、CI ステータス、ライセンス、言語／ランタイムのバージョン、パッケージレジストリのバージョン、コードカバレッジがあります。ライブエンドポイントがない場合は、shields.io の静的バッジを使用してください。バッジが 3 つ以上ある行では、参照形式の Markdown リンクを優先してください。ソースを読みやすく保てます。壊れていたり、常に失敗したりするバッジを載せるより、載せないほうが適切です。メンテナンスされているものだけを含めてください。

作業手順

1. プロジェクトを調査する

書き始める前に、プロジェクトの実際の状態を確認してください。

  • すべてのスキル／モジュールのディレクトリと、その SKILL.md または同等の説明ファイルを調べます。
  • 各コンポーネントの名前、1 行での目的、インストール方法、特筆すべき前提条件を確認します。
  • 最近の追加や削除について、git log を確認します。
  • 既存の README ファイルを読み、現在の内容と古くなっている箇所を把握します。

記憶や推測ではなく、実際の情報に基づいて記述してください。

2. README.md（英語）を下書きする

構成の出発点として references/template.md を使用します。セクション名はプロジェクトの分野に合わせて変更してください。テンプレートは骨組みを示すもので、文言を指定するものではありません。

セクションの順序（該当しないものは省略し、項目を埋めるためだけにセクションを追加しないでください）：

  1. ヘッダー — タイトル + バッジ + 言語切り替え
  2. 簡潔な説明（1 文）
  3. ロゴ、バナー、デモ GIF — 任意。ただし、ある場合は早い位置に配置します
  4. 主な内容のセクション（利用可能な項目、使い方など）
  5. 貢献／新しい項目の追加
  6. ライセンス

約 300 行を超える README には、簡潔な説明の後に目次を追加してください。

README はディレクトリであり、チュートリアルではありません。各コンポーネントの説明は 1～2 文にしてください。インストールコマンドは、そのままコピーして実行できるよう、曖昧さのない正確なコマンドにします。言語タグ（```bash、```json）を付けたフェンス付きコードブロックを必ず使用してください。

人が書いたような自然な文章にしてください。README の文章は AI らしい定型表現が蓄積しやすいものです。「堅牢」、太字で始まる箇条書き、「～として機能します」といった表現が、気づかないうちに増えがちです。次の点に注意してください。

  • 単語の選び方：「活用する」「効率化する」「堅牢な」「利用する」「深掘りする」は避け、平易な表現にしてください。
  • 箇条書き：すべての項目を太字のフレーズで始めないでください。AI が生成したドキュメントのように読めてしまいます。
  • 説明：コンポーネントが何をするかを述べ、「～として機能する」「～としての役割を果たす」といった表現は避けてください。
  • 宣伝調：「強力な」「シームレスな」「包括的な」は何も伝えません。削除してください。
  • つなぎの冗長表現：「注目すべき点として」「重要なのは」「特筆すべきことに」は削除してください。

有効な確認方法は、各文を声に出して読むことです。宣伝文句のように聞こえる場合は、事実を簡潔に述べる表現に書き直してください。

3. README.zh-CN.md の下書きを作成する（中国語）

英語版の README に忠実に翻訳してください。ルール：

  • 自然な簡体字中国語を使ってください。英語で広く使われている技術用語（CLI ツール名、パッケージマネージャーのコマンド、GitHub の URL、コードブロック）は翻訳しないでください。
  • コードブロック、コマンド、ファイルパスはすべて英語版と同じにしてください。
  • セクション見出しは、逐語訳ではなく、自然な中国語にしてください（例：「利用可能なスキル」「新しいスキルの追加」）。
  • 言語切り替えは [English](README.md) | **Simplified Chinese** にしてください。
  • 英語版と同じく、平易な表現を心がけてください。中国語の技術文書にも AI らしい表現があります。簡単な言葉で済むところでは、流行語を避けてください。
4. 執筆前に確認する

どちらのファイルも書き始める前に、次の点を確認してください。

  • 記載されているすべてのスキル／コンポーネントが、現在リポジトリに存在すること
  • インストールコマンドがコピーして実行でき、正確であること
  • 削除済みの内容を説明しているセクションがないこと
  • 2 つのファイルで、同じ内容を同じ順序で扱っていること

その後、下書きの文章を見直し、次の点を確認してください。

  • ダッシュが全体で 2～3 回を超えて使われていませんか？大部分を削ってください。
  • 「The X serves as...」で始まる文はありませんか？「The X is...」に書き換えてください。
  • 箇条書き全体で、太字の語句から始めるパターンが続いていませんか？太字を外してください。
  • 複数の説明で同じ単語や比喩を繰り返していませんか？表現を変えてください。
  • Unicode の矢印（→）を使っていませんか？通常のテキストに置き換えてください。
5. ファイルを書く

最初に README.md を書き、次に README.zh-CN.md を書いてください。Edit または Write ツールを使ってください。会話内でコードブロックとして内容を出力しないでください。

書き終えたら、変更内容を簡潔に報告してください（例：「update-readme スキルを追加し、古くなった apple-events の前提条件に関する注記を削除しました」）。

参考資料

  • references/template.md — README の構成テンプレート（下書きの作成時に読み込んでください）

コメント

Markdown 対応