mcpField
B
bmad-index-docs

bmad-index-docs

github.com/bmad-code-orgドキュメント54.7k259 回インストール1 週間前に更新
リポジトリ

bmad-index-docs について

対象ディレクトリを走査してファイルを分類し、内容に基づく短い説明を付けて`index.md`を作成または更新するスキルです。文書ディレクトリの整理に使えます。

主な機能

  1. 01ファイルとサブディレクトリを走査
  2. 02種類や目的ごとに分類
  3. 03内容に基づく説明を作成
  4. 04index.mdを作成または更新
  5. 05相対パスを使って項目を並べ替え

活用シーン

  1. 01文書フォルダーの索引を作成
  2. 02ファイル変更後に一覧を更新

インストール

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

$npx skills add https://github.com/bmad-code-org/bmad-method --skill bmad-index-docs

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

詳細

Index ドキュメント

目的: 対象フォルダー内のすべてのドキュメントを参照する index.md を生成または更新します。

実行

ステップ 1: ディレクトリのスキャン
  • 対象の場所にあるすべてのファイルとサブディレクトリを一覧表示します
ステップ 2: コンテンツのグループ化
  • ファイルを種類、目的、またはサブディレクトリごとに整理します
ステップ 3: 説明の生成
  • 各ファイルを読み込み、その実際の目的を理解したうえで、ファイル名だけでなくコンテンツに基づいて簡潔な（3～10 語の）説明を作成します
ステップ 4: Index の作成/更新
  • 整理されたファイル一覧を含む index.md を作成または更新します

出力形式

# Directory Index

## Files

- **[filename.ext](./filename.ext)** - Brief description
- **[another-file.ext](./another-file.ext)** - Brief description

## Subdirectories

### subfolder/

- **[file1.ext](./subfolder/file1.ext)** - Brief description
- **[file2.ext](./subfolder/file2.ext)** - Brief description

### another-folder/

- **[file3.ext](./another-folder/file3.ext)** - Brief description

停止条件

  • 対象ディレクトリが存在しない、またはアクセスできない場合は停止します
  • ユーザーに index.md を作成する書き込み権限がない場合は停止します

検証

  • ./ で始まる相対パスを使用します
  • 類似するファイルをまとめてグループ化します
  • 正確な説明を生成するためにファイルの内容を読み込みます - ファイル名から推測しないでください
  • 説明は簡潔かつ情報量のあるものにします（3～10 語）
  • グループ内ではアルファベット順に並べます
  • 指定がない限り、隠しファイル（. で始まるもの）はスキップします

コメント

Markdown 対応