mcpField
R
readme-updater

readme-updater

github.com/ovachiever開発5699 回インストール48 週間前に更新
リポジトリ

readme-updater について

readme-updaterは、コードや設定の変更に合わせてREADMEを保つドキュメントスキルです。一般的な変更を検出して編集案を提示し、既存の構成や文体を維持します。

主な機能

  1. 01コードと設定の変更を検出
  2. 02変更をREADMEの各節に対応付け
  3. 03セットアップ・機能・使用法を更新
  4. 04既存の書式と文体を維持
  5. 05変更履歴と同期

活用シーン

  1. 01新機能の追加をREADMEに記録
  2. 02依存関係の変更後に設定手順を更新
  3. 03API変更後に使用例を更新

インストール

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

$npx skills add https://github.com/ovachiever/droid-tings --skill readme-updater

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

同梱ファイルREADME.md

詳細

README 更新スキル

プロジェクトの変更に合わせて README を最新の状態に保ちます。

起動するタイミング

  • ✅ 新機能が追加されたとき
  • ✅ プロジェクト構成が変更されたとき
  • ✅ 依存関係が追加または削除されたとき
  • ✅ セットアップ手順が変更されたとき
  • ✅ README またはドキュメントについてユーザーから言及されたとき
  • ✅ 設定ファイルが変更されたとき

更新する内容

README のセクション

インストール：

  • 新しい依存関係
  • セットアップ手順
  • 前提条件
  • 環境変数

機能：

  • 新しい機能
  • 機能の変更
  • 機能の非推奨化

使い方：

  • API の変更
  • 新しい例
  • 更新されたスクリーンショット

設定：

  • 新しいオプション
  • 環境変数
  • 設定ファイルの変更

例

新機能の追加
# You add authentication:
git diff
# + auth.service.ts
# + login.component.tsx
# + JWT middleware

# I suggest README update:
## Features
- ✨ User authentication with JWT  # NEW
- 🔐 Role-based access control    # NEW
- User management
- Dashboard
新しい依存関係
# You add: npm install stripe

# I suggest:
## Installation

```bash
npm install
npm install stripe  # Added for payment processing

環境変数

STRIPE_SECRET_KEY=your_stripe_key  # Required for payments


### Setup Instructions

```bash
# You modify docker-compose.yml

# I update README:
## Development Setup

```bash
# 1. Clone repository
git clone [url]

# 2. Install dependencies
npm install

# 3. Start services (UPDATED)
docker-compose up -d  # Now includes Redis cache

# 4. Run migrations
npm run migrate


## Detection Logic

### Change Analysis

I detect these changes automatically:
- **package.json** → Update dependencies section
- **New routes** → Update API documentation
- **.env.example** → Update environment variables
- **docker-compose.yml** → Update setup instructions
- **New features** → Update features list

### Section Mapping

```yaml
Code Change → README Section:
  - New API endpoint → Usage / API Reference
  - New dependency → Installation
  - New env var → Configuration
  - New feature → Features list
  - Architecture change → Architecture section

インテリジェントな更新

構成を維持

README の構成を維持します：

  • 絵文字のスタイルを保つ
  • 書式の一貫性を保つ
  • 文体や語調を維持する
  • 既存の構成を尊重する
不足しているセクションを追加
# Suggested additions:

## Prerequisites
- Node.js 18+
- Docker (for development)
- PostgreSQL 14+

## Environment Variables
```bash
DATABASE_URL=postgresql://localhost/mydb
API_KEY=your_api_key

テスト

npm test


### Update Examples

```markdown
# Before:
```javascript
const result = api.getUsers();

更新後（API が変更された場合）：

const result = await api.getUsers({ page: 1, limit: 10 });


## Version Compatibility

I track version-specific documentation:

```markdown
## Requirements

- Node.js 18+ (updated from 16+)
- TypeScript 5.0+ (new requirement)
- React 18+ (unchanged)

変更履歴との連携

CHANGELOG.md と同期できます：

## Recent Changes

See [CHANGELOG.md](CHANGELOG.md) for detailed version history.

### Latest (v2.1.0)
- ✨ Added user authentication
- 🔧 Fixed memory leak in data processing
- 📝 Updated API documentation

スクリーンショットの管理

# I suggest when UI changes:
## Screenshots

![Dashboard](screenshots/dashboard.png)
*Updated: 2025-10-24 - New authentication panel*

![User Profile](screenshots/profile.png)
*New feature - user profile management*

@docs-writer との関係

私（スキル）： コードの変更に合わせて README を最新の状態に保ちます @docs-writer（サブエージェント）： 包括的なドキュメント戦略を担当します

ワークフロー
  1. 変更を検出します
  2. README の更新を提案します
  3. ドキュメント全体が必要な場合 → @docs-writer サブエージェントを呼び出します
  4. サブエージェントが完全なドキュメントを作成します

サンドボックスとの互換性

サンドボックスなしで動作： ✅ はい サンドボックスありで動作： ✅ はい

  • ファイルシステム： README.md に書き込みます
  • ネットワーク： 不要です
  • 設定： 不要です

ベストプラクティス

  1. 最新の状態を保つ - 機能を追加するたびに README を更新します
  2. 具体的に記載する - バージョン番号や前提条件を含めます
  3. 例を追加する - API だけでなく、実際の使い方を示します
  4. トラブルシューティングを含める - よくある問題と解決方法を記載します
  5. バッジの状態を保つ - ビルドやカバレッジのバッジを最新の状態に保ちます

README テンプレート

基本構成
# Project Name

Brief description

## Features
- Feature 1
- Feature 2

## Installation
```bash
npm install

使い方

// Example

設定

必要な環境変数

コントリビューション

貢献方法

ライセンス

MIT


### Comprehensive Structure

```markdown
# Project Name
> Tagline

[Badges]

## Table of Contents
- Features
- Installation
- Usage
- API Reference
- Configuration
- Development
- Testing
- Deployment
- Contributing
- License

[Sections with detailed content]

連携

/docs-gen コマンドとの連携
/docs-gen --format markdown

# Generates:
# 1. README.md (via me)
# 2. Full documentation site (via @docs-writer)
# 3. API reference (via api-documenter)
CI/CD との連携
# .github/workflows/docs.yml
- name: Update README
  run: |
    # Skill suggests updates based on changes
    # Review and commit

カスタマイズ

会社固有の README 基準を追加します：

cp -r ~/.claude/skills/documentation/readme-updater \
      ~/.claude/skills/documentation/company-readme-updater

# Edit to add:
# - Company README template
# - Required sections
# - Badge standards

関連ツール

  • api-documenter スキル：API ドキュメント
  • @docs-writer サブエージェント：包括的なドキュメント
  • git-commit-helper スキル：更新時のコミットメッセージ
  • /docs-gen コマンド：ドキュメント全体の生成

コメント

Markdown 対応