Update Agents Md

プロジェクト情報管理スキル (update-agents-md)

プロジェクト固有の情報をAGENTS.mdとして管理し、AIエージェントが効率的にリポジトリを理解できるようにするためのスキル。

目的

• AIエージェント（GitHub Copilot、Claude Code等）がプロジェクトを素早く理解できる情報を提供
• AGENTS.mdをマスターファイルとし、CLAUDE.mdをシンボリックリンクとして設定
• プロジェクトの構造、技術スタック、重要な情報を一元管理

実行フロー

1. 前提確認

• Gitリポジトリルートを特定する
• 既存のAGENTS.md/CLAUDE.mdの有無を確認

2. プロジェクト調査

以下の情報を収集する：

1. プロジェクト概要 - README.md、package.jsonなどから目的と概要を把握
2. ディレクトリ構造 - 主要なディレクトリとその役割
3. 技術スタック - 使用言語、フレームワーク、ツール
4. 主要機能・コンポーネント - 重要なモジュールやエントリポイント
5. 開発環境・ツール - ビルド、テスト、リント、デプロイ関連
6. 重要な設定ファイル - 設定ファイルの場所と役割
7. その他の重要情報 - 環境変数、APIキー、外部サービス連携など

3. AGENTS.md作成/更新

新規作成時

1. プロジェクト調査結果を基にAGENTS.mdを生成
2. CLAUDE.mdをシンボリックリンクとして作成：ln -s AGENTS.md CLAUDE.md

更新時

1. 既存のAGENTS.mdをバックアップ（必要に応じて）
2. 変更内容を確認してから更新
3. シンボリックリンクが正しいか確認

4. 検証

• ファイルが正しく作成/更新されたか確認
• シンボリックリンクが正常に機能するか確認

AGENTS.mdの構成テンプレート

# AGENTS.md

This file provides guidance to AI agents (Claude Code, GitHub Copilot) when working with code in this repository.

## Project Overview

[プロジェクトの目的と概要を記述]

## Directory Structure

[主要ディレクトリの役割を記述]

## Tech Stack

- **言語**: [使用言語]
- **フレームワーク**: [使用フレームワーク]
- **ツール**: [ビルドツール、パッケージマネージャ等]

## Key Components

[主要なモジュール、クラス、関数の説明]

## Essential Commands

[頻繁に使用するコマンドをリスト]

## Configuration Files

[重要な設定ファイルの説明]

## Development Workflow

[開発フロー、ブランチ戦略、コードレビュールール等]

## Important Notes

[注意事項、制約、既知の問題等]

使用例

新規プロジェクトでの初期設定

# Gitリポジトリルートで実行
cd /path/to/your/project

# AGENTS.mdが存在しない場合、調査して新規作成
# CLAUDE.mdをシンボリックリンクとして作成

既存ドキュメントの更新

# プロジェクト構造の変更後に更新
# 新機能追加後のドキュメント同期

ベストプラクティス

1. 定期的な更新 - 大きな変更があった際はAGENTS.mdを更新する
2. 簡潔さの維持 - 冗長な説明を避け、エージェントが必要とする情報に絞る
3. コード例の活用 - 抽象的な説明よりも具体的なコード例やコマンドを優先
4. リンクの活用 - 詳細なドキュメントへのリンクを活用して本文を簡潔に保つ
5. シンボリックリンクの維持 - CLAUDE.mdは常にAGENTS.mdへのシンボリックリンクとする

関連ファイル

• scripts/check_agents_md.sh - AGENTS.md/CLAUDE.mdの状態確認スクリプト

Converted and distributed by TomeVault — claim your Tome and manage your conversions.