SuperAPI AI 工具集

doc-scanner

写作与研究

查看项目

更新于 10-13 16:40

技能介绍

用途

doc-scanner 用于扫描项目中的文档文件并将其整合为统一指引。它适用于以下场景:用户要求审查、理解或探索某个代码库;开始在一个新的或不熟悉的项目中工作;用户询问项目约定或工作流;在做出重大架构决策之前。

主要能力

  • 扫描项目根目录下的文档文件,覆盖 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 等格式。
  • 读取所有找到文档文件的完整内容。
  • 将信息综合为统一摘要,结构包括:来源文件列表、推荐智能体(主要/次要)、关键工作流、项目约定(代码风格与模式)、常用命令。
  • 若存在两个及以上文档文件,可提议整合:创建 .doc-archive/ 目录,为原始文件添加日期后缀归档,生成统一的 AGENTS.md,并报告整合内容。
  • 若未找到文档,可提议使用 repo-doctor 技能的脚手架起草 AGENTS.md。

使用方式

分步骤执行:

  1. 扫描文档:使用 Glob 在项目根目录搜索上述文件。
  2. 读取所有找到的文件:读取每个文档文件的完整内容。
  3. 综合:合并为统一摘要,按 PROJECT DOCUMENTATION、Sources、RECOMMENDED AGENTS、KEY WORKFLOWS、CONVENTIONS、QUICK COMMANDS 组织。
  4. 提供整合选项:若存在 2 个以上文档文件,提议整合。
  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

文件优先顺序:AGENTS.md(平台无关)、CLAUDE.md(Claude 专用)、其他 AI 文档、IDE 文档、终端文档。

附加资源

  • ./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 处理。

适用场景

适用于进入陌生代码库、需要快速理解项目约定与工作流的场景,也适用于在重大架构决策前梳理现有文档,或将多个平台的分散文档统一为单一 AGENTS.md 的场景。

限制

该技能依赖项目根目录下是否存在可识别的文档文件;未找到文档时的草稿生成依赖 repo-doctor 技能的脚手架。关于收费、价格、平台支持范围等细节,资料暂未提供。