Community编程与开发github.com

代码库侦察与架构映射 (scouting)

通过调查仓库文档和代码,生成侦察报告和架构文档。适用于在规划或入职前评估代码库。

代码库侦察与架构映射 (scouting) 是什么?

该技能旨在帮助开发者在接手新代码库或进行规划前,全面快速地了解其健康状况、文档准确性以及系统架构。它会指示AI代理执行一个严格的多步骤流程:首先要求用户选择最适合的模型(如Sol用于快速遍历,Claude Sonnet用于深度分析,Kimi K3用于处理超大上下文),然后依次扫描项目文档和实际代码,进行比对,评估模块化程度、错误处理、测试覆盖率等工程实践。最终输出两份关键文档:`SCOUTING_REPORT.md`(包含文档健康审计、代码库健康评估及三项首要待办事项)和 `ARCHITECTURE.md`(包含基于实际代码的系统架构图、组件边界、数据流和外部契约)。该技能适用于Claude Code、Cursor、Codex等支持自定义技能的AI编码代理平台,通过明确定义的角色和步骤,确保评估结果的一致性和深度,减少人工审查成本。

兼容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/titaniumcoder/titaniumcoder-skills/tree/HEAD/skills/scouting

Installed? Explore more 编程与开发 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

技能:代码库侦察与架构映射 (scouting)

角色与目标

你是一位首席首席工程师兼系统架构师。你的工作是侦察任何内部或外部仓库,且不修改任何源代码。首先扫描文档,然后扫描实际代码库,并生成两份 Markdown 交付物:

  1. SCOUTING_REPORT.md(文档健康度、文档漂移审计和代码库健康度)
  2. ARCHITECTURE.md(当前状态的系统架构)

第0步:强制模型选择门(停下来,先询问)

关键规则: 不要立即扫描代码库或读取文件。先询问用户他们想为此侦察任务使用哪个模型,并等待用户确认(或让他们通过 /model 切换):

  1. Sol —— 最适合超快仓库遍历、快速文件扫描和快速结构映射。
  2. Claude Sonnet —— 最适合深度架构综合、边界分析和细致的代码库评估。
  3. Kimi K3 —— 最适合在大型文档树和庞大单体仓库中处理海量上下文窗口。

等待用户确认后再进入第1步。


第1步:文档侦察

首先扫描所有现有文档,以了解项目声称是什么:

  1. 读取 README*、CONTRIBUTING*、ARCHITECTURE*、AGENTS.md、CLAUDE.md、DESIGN.md、docs/**、变更日志以及任何 ADR 或设计规范。
  2. 检查构建、包和工作区清单文件(如 Cargo.toml、go.mod、mix.exs、package.json、pom.xml、build.gradle*、pyproject.toml、Makefile、Justfile、Dockerfile、CI/CD 工作流等)。
  3. 记录声称的架构、技术栈、设置和设计模式。

第2步:代码库侦察

扫描实际的目录结构、入口点、核心模块和测试:

  1. 真实性 vs. 文档检查: 比较实际的入口点、公共 API、数据模型、CLI/配置标志和依赖项与文档声称的内容是否一致。
  2. 结构与工程评估: 抽样核心实现和测试文件以评估:
    • 模块化与边界: 职责是否清晰分离,或者是否存在循环依赖和单体热点?
    • 错误处理与安全性: 在模块边界之间如何处理错误、panic、边缘情况和类型?
    • 测试覆盖率与测试框架: 存在什么样的测试套件(单元测试、集成测试、端到端测试、基准测试)以及哪些关键路径未经测试?

第3步:交付物 1 — SCOUTING_REPORT.md

创建 docs/SCOUTING_REPORT.md(如果 docs/ 目录不存在,则放在根目录),遵循以下结构:

  • 头部: 日期、使用的模型、主要语言、框架和版本。
  • 1. 文档健康度与漂移审计:
    • 状态(良好 / 部分 / 过期 / 缺失)和准确度(0-100%)。
    • 准确且最新的内容。
    • 文档漂移:文档与实际代码相矛盾的地方、损坏的设置/构建命令、缺失的环境变量或未记录的模块。
    • 缺失的关键文档:开发人员或代理下一步需要记录的内容。
  • 2. 代码库健康度与结构评估:
    • 代码组织: 是否符合该技术栈的惯用模式。
    • 错误处理与类型严谨性: 优势和薄弱点(引用具体文件)。
    • 测试套件评估: 当前的测试策略、工具和差距。
    • 复杂性热点: path/to/file + 需要关注的原因。
  • 3. 前3项即时行动项: 优先级的修复或文档更新。

第4步:交付物 2 — ARCHITECTURE.md

创建或更新 docs/ARCHITECTURE.md(或放在根目录),反映实际代码,而非一厢情愿的文档:

  • 1. 系统概览与运行时模型: 对目的、执行模型和部署目标的简要总结。
  • 2. 组件与数据流图: 使用 Mermaid graph TD 图来映射实际的 crate/包/模块和服务边界。
  • 3. 目录与边界映射: 关键文件夹/模块、状态所有权以及它们之间严格的依赖方向。
  • 4. 数据持久化、状态与并发: 存储层、模式、内存/状态模型以及实际中使用的并发原语。
  • 5. 外部契约: CLI 标志、公共库特性/接口、HTTP/gRPC API、事件或自定义资源。

第5步:完成

在聊天中总结关键发现。如果环境中存在 Plannotator,提及 /plannotator-annotate docs/SCOUTING_REPORT.md 以供审查和标注。切勿提示用户切换到其他技能。

Individual skills in this repo

This repo contains 2 individual skills — each has its own dedicated page.

相关技能