mcpField
D
doc-scanner

doc-scanner

github.com/0xdarkmatterエージェントワークフロー7864 回インストール2 週間前に更新
リポジトリ

doc-scanner について

doc-scannerは、コードベースのドキュメントを調べるスキルです。AIや各種ツール向けの指示ファイルを探して内容をまとめ、複数ある場合は統合を提案します。

主な機能

  1. 01プロジェクト指示ファイルの検索
  2. 02見つかったドキュメントの読み込み
  3. 03プロジェクト概要への情報集約
  4. 04複数ファイルの統合提案
  5. 05文書がない場合のAGENTS.md作成提案

活用シーン

  1. 01不慣れなコードベースの把握
  2. 02設計前のプロジェクト規約確認
  3. 03分散したAI向け指示の整理と統合

インストール

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

$npx skills add https://github.com/0xdarkmatter/claude-mods --skill doc-scanner

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

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

assets/
.gitkeep
references/
file-patterns.md
templates.md
scripts/
.gitkeep

詳細

ドキュメントスキャナー

プロジェクトのドキュメントをスキャンし、情報を統合します。

有効にするタイミング

  • ユーザーがコードベースのレビュー、把握、調査を依頼したとき
  • 新しいプロジェクトや不慣れなプロジェクトで作業を開始するとき
  • ユーザーがプロジェクトの規約やワークフローについて尋ねたとき
  • 重要なアーキテクチャ上の判断を下す前

手順

ステップ 1：ドキュメントをスキャンする

Glob を使ってプロジェクトのルートを検索します。

AGENTS.md, CLAUDE.md, AI.md, ASSISTANT.md,
GEMINI.md, COPILOT.md, CHATGPT.md, CODEIUM.md,
CURSOR.md, WINDSURF.md, VSCODE.md, JETBRAINS.md,
WARP.md, FIG.md, DEVCONTAINER.md, GITPOD.md
ステップ 2：見つかったファイルをすべて読む

見つかったドキュメントファイルの内容をすべて読みます。

ステップ 3：情報を統合する

情報をまとめて、統一された要約を作成します。

PROJECT DOCUMENTATION

Sources: [list files found]

RECOMMENDED AGENTS
  Primary: [agents for core work]
  Secondary: [agents for specific tasks]

KEY WORKFLOWS
  [consolidated workflows]

CONVENTIONS
  [code style, patterns]

QUICK COMMANDS
  [common commands]
ステップ 4：統合を提案する

ドキュメントファイルが 2 つ以上ある場合は、統合を提案します。

  1. .doc-archive/ ディレクトリを作成する
  2. 元のファイルを日付の接尾辞付きでアーカイブする
  3. 統合版の AGENTS.md を作成する
  4. 統合した内容を報告する
ステップ 5：ドキュメントが見つからない場合

何も見つからない場合は、repo-doctor スキルのひな形を使って AGENTS.md の草案を作成するよう提案します。このスキルは推測に頼らず、根拠に基づく詳細なスキャン（宣言されているスクリプトのみを対象にし、git 履歴から落とし穴に関する質問を抽出）から草案を作成します。

# run from the repo-doctor skill's directory
python scripts/agents-md.py scaffold --repo path/to/project > AGENTS.draft.md

優先順位

  1. AGENTS.md（プラットフォームに依存しない）
  2. CLAUDE.md（Claude 固有）
  3. その他の AI ドキュメント
  4. IDE のドキュメント
  5. ターミナルのドキュメント

その他のリソース

詳細なパターンについては、次を読み込みます。

  • ./references/file-patterns.md - スキャン対象ファイルの一覧
  • ./references/templates.md - 統合用テンプレート（複数のプラットフォーム向けドキュメントを統合する場合）

AGENTS.md 標準そのもの（内容、150／200 行の上限、CLAUDE.md によるシャドーイング）については、repo-doctor スキルの references/agents-md-protocol.md を参照してください。統合する際は、この標準に沿うようにします。また、CLAUDE.md を残す必要がある場合は、先頭行を @AGENTS.md にしてください。Claude Code は CLAUDE.md が存在する場合、CLAUDE.md ファイルのみを読み込むためです。既存の AGENTS.md を監査または更新するには、repo-doctor の agents-md.py audit --diff に引き継ぎます。

コメント

Markdown 対応