readme-sync
Automatically syncs your README documentation with recent code changes, API updates, and feature additions.
Install
mkdir -p .claude/skills/readme-sync && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/15261" && unzip -o skill.zip -d .claude/skills/readme-sync && rm skill.zipInstalls to .claude/skills/readme-sync
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
コードの変更に追随して README の該当セクションを書き直す。 ユーザーが「READMEを更新して」「ドキュメントを直して」「READMEに反映して」 などと言った時に使用する。Key capabilities
- →Analyze code changes to identify updates
- →Identify sections in README.md requiring updates
- →Update installation/setup instructions
- →Reflect API changes in reference sections
- →Add migration instructions for breaking changes
How it works
The skill analyzes git diffs to understand code changes and then updates the corresponding sections in the README.md based on predefined rules and templates.
Inputs & outputs
When to use readme-sync
- →Update README after adding new CLI flags or features
- →Sync API Reference sections with updated method signatures
- →Add migration instructions for breaking changes
- →Update installation or environment requirement sections
About this skill
README更新
コードの変更内容を解析し、READMEの対応するセクションを自動更新します。
使い方
- 「READMEを更新して」→ 現在の差分に基づいてREADMEを更新
- 「新機能をREADMEに追記して」→ 追加された機能をドキュメントに反映
- 「APIの変更をREADMEに反映して」→ インターフェース変更を反映
手順
1. 変更内容の把握
# コードの差分を確認
git --no-pager diff main...HEAD --stat
git --no-pager diff main...HEAD
変更の種類を分類する：
- 新機能の追加
- 既存機能の変更（APIシグネチャ・設定値など）
- 機能の削除・非推奨化
- インストール手順・環境要件の変更
2. 現在のREADMEを読み込む
cat README.md
READMEの構成を把握し、更新が必要なセクションを特定する。
3. 更新が必要なセクションの特定
| 変更種別 | 更新対象セクション |
|---|---|
| 新機能追加 | Features / Usage / API Reference |
| 設定変更 | Configuration / Environment Variables |
| インターフェース変更 | API Reference / Usage Examples |
| 依存関係変更 | Installation / Requirements |
| 破壊的変更 | Migration Guide / BREAKING CHANGES |
| バグ修正 | 通常は不要（CHANGELOGへ） |
4. READMEの更新
以下のルールに従って更新する：
書き方の原則
- 簡潔に: 長い説明より短い例を優先する
- 動作するコード例: コピー&ペーストで動くサンプルを書く
- バージョン明記: 変更がバージョン依存の場合は明記する
- 既存スタイルに合わせる: 文体・見出しレベル・コードブロック言語を統一する
セクション別の更新内容
Installation / Setup
## インストール
```bash
npm install <package-name>@<version>
**Usage / Getting Started**
- 最小限の動作例を最初に示す
- オプション・設定は後のセクションで説明
**API Reference / Configuration**
- 変更・追加されたプロパティ・メソッドを反映
- 削除された項目は `**Deprecated**` を付けるか削除
**Breaking Changes（破壊的変更の場合）**
```markdown
## v2.0 からの移行
### 変更点
| 旧 | 新 |
|---|---|
| `oldOption` | `newOption` |
5. 更新内容のプレビュー
更新後のREADMEをプレビュー表示し、ユーザーに確認を求めてから適用する。
When not to use it
- →When the change is a bug fix that belongs in a CHANGELOG
- →When the user does not explicitly ask to update the README or documentation
Limitations
- →Updates are based on predefined section types
- →Requires explicit user instruction to update the README
- →Bug fixes usually do not require README updates
How it compares
This skill automates the process of updating README.md sections based on code changes, ensuring documentation stays synchronized with the codebase, unlike manual updates.
Compared to similar skills
readme-sync side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| readme-sync (this skill) | 0 | 1mo | Review | Beginner |
| updating-changelog | 1 | 5mo | Review | Intermediate |
| releasenotes | 1 | 2mo | No flags | Beginner |
| bd-to-br-migration | 1 | 6mo | Review | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
updating-changelog
AztecProtocol
Updates changelog documentation for contract developers and node operators by analyzing branch changes relative to 'next'. Use when preparing a PR, updating migration notes, documenting breaking changes, or when asked to update changelog/release notes.
releasenotes
exceptionless
Generate formatted changelogs from git history since the last release tag. Use when preparing release notes that categorize changes into breaking changes, features, fixes, and other sections.
bd-to-br-migration
Dicklesworthstone
Migrate docs from bd (beads) to br (beads_rust). Use when updating AGENTS.md, converting bd commands, "bd sync" → "br sync --flush-only", or beads migration.
pr-demo
mikeyobrien
Use when creating animated demos (GIFs) for pull requests or documentation. Covers terminal recording with asciinema and conversion to GIF/SVG for GitHub embedding.
tutorial-any-repo
TKONIY
Automatically generate a file-by-file code tutorial website for any repository. Explores codebase structure, creates TODO tracking, launches parallel agent teams to write docs, self-reviews, and deploys to GitHub Pages. Use when user says "write a tutorial for this project", "explain this codebase",
ml-paper-writing
davila7
Write publication-ready ML/AI papers for NeurIPS, ICML, ICLR, ACL, AAAI, COLM. Use when drafting papers from research repos, structuring arguments, verifying citations, or preparing camera-ready submissions. Includes LaTeX templates, reviewer guidelines, and citation verification workflows.