mcpField
D
doc-scanner

doc-scanner

github.com/0xdarkmatterAgent 工作流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.md 时，Claude Code 只会读取 CLAUDE.md 文件。若要审计或升级现有 AGENTS.md，请转交给 repo-doctor 的 agents-md.py audit --diff。

评论

支持 Markdown