AgentSkillsCN

update-docs

根据项目现状,更新 CLAUDE.md 与 README.md 文件。

SKILL.md
--- frontmatter
name: update-docs
description: CLAUDE.md と README.md をプロジェクトの現状に合わせて更新します

Update Docs

プロジェクトのディレクトリ構成や技術スタックを再検出し、CLAUDE.md と README.md を最新状態に更新します。

実行手順

1. プロジェクト情報の収集

ディレクトリ構成の取得

bash
# ディレクトリ構成を確認(.git, node_modules 等は除外)
find . -maxdepth 3 -not -path './.git/*' -not -path './node_modules/*' -not -path './vendor/*' -not -path './__pycache__/*' -not -path './target/*' -not -path './.venv/*' -not -path './dist/*' -not -path './build/*' | sort

技術スタック・依存関係の確認

bash
# パッケージマネージャの設定ファイルを確認
ls package.json pyproject.toml requirements.txt Gemfile go.mod Cargo.toml composer.json pom.xml build.gradle 2>/dev/null

既存ドキュメントの読み取り

既存の CLAUDE.mdREADME.md の内容を読み取り、現在の構造を把握します。

2. CLAUDE.md の更新

更新対象セクション

  • プロジェクト構成: ディレクトリツリーを現在の状態に更新
  • 利用技術: 検出された技術スタックに基づいて更新
  • その他のセクション(コミュニケーション言語、目的等)は変更しない

更新手順

  1. 現在のディレクトリ構成からツリー図を生成
  2. 既存の CLAUDE.md と差分を比較
  3. 差分をユーザーに提示
  4. ユーザーの確認後に反映

3. README.md の更新

更新対象セクション

  • プロジェクト概要: 必要に応じて更新
  • セットアップ手順: 変更があれば更新
  • ディレクトリ構成: 現在の状態に更新
  • その他: プロジェクト固有のセクション

更新手順

  1. 既存の README.md を読み取り
  2. プロジェクトの現状と比較
  3. 更新案をユーザーに提示
  4. ユーザーの確認後に反映

4. 変更の確認

更新前にユーザーに差分を表示し、確認を求めます。

  • 変更箇所を明確にマークする
  • 追加・削除・変更された行を分かりやすく表示する
  • ユーザーの承認なしにファイルを書き換えない

注意事項

  • CLAUDE.md と README.md の既存の書き方・トーンを維持する
  • セクションの順序は既存のものを尊重する
  • 自動検出できない情報(プロジェクトの目的、コミュニケーション言語など)は変更しない
  • 更新は必ずユーザーの確認後に行う
  • ドキュメントに記載されている情報が実際のプロジェクト状態と矛盾していないか確認する