Pular para o conteúdo
Skillpedia
Documentação41 mil · #4953

scan

Faz seu agente gerar documentação do projeto. É útil para manter a documentação atualizada, especialmente após mudanças no código.

O que ela faz

Este agente analisa o código do seu projeto para criar documentação automática. Ele gera dois arquivos: um resumo técnico do projeto e um guia para outros agentes de IA.

Quando usar

  • ✓Ao iniciar um novo projeto para documentá-lo.
  • ✓Após fazer grandes mudanças na estrutura do código.
  • ✓Para verificar se o código mudou desde a última análise.

Exemplo do que pedir para a IA

“Analise o código e gere a documentação do projeto e o arquivo AGENTS.md.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/wshobson/agents/blob/main/plugins/ship-mate/skills/scan/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/wshobson/agents/blob/main/plugins/ship-mate/skills/scan/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

Ele verifica se há ferramentas extras que ajudam na análise. Depois, decide se vai analisar tudo (primeira vez) ou só o que mudou. Por fim, escreve os arquivos de documentação.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add wshobson/agents --skill scan

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/wshobson/agents/main/plugins/ship-mate/skills/scan/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Scanner de Código

Você é um analista técnico. Seu trabalho é escanear a base de código do projeto e produzir documentação precisa e específica do projeto, usada por todos os agentes downstream.

Etapa 1: Verificar Dependências de Plugins Opcionais

Verifique se os dois plugins de aprimoramento opcionais estão disponíveis:

understand-anything  →  /plugin list | grep understand-anything
context-mode         →  /plugin list | grep context-mode

Esses plugins são opcionais. Eles melhoram a qualidade da varredura, mas não são obrigatórios:

  • understand-anything (Lum1104/Understand-Anything) — fornece análise semântica de código mais profunda
  • context-mode (mksglu/context-mode) — roteia saídas grandes através de um sandbox para proteger a janela de contexto

Se ambos estiverem presentes, use-os nas Etapas 3-4 conforme descrito abaixo. Se um ou ambos estiverem faltando, prossiga com a abordagem de fallback nativo: use os comandos find, grep, cat e git diretamente, roteando saídas grandes através de ctx_execute / ctx_execute_file se o context-mode estiver disponível, caso contrário, resuma inline.

Observação: Para instalar os plugins opcionais manualmente:

/plugin marketplace add Lum1104/Understand-Anything && /plugin install understand-anything
/plugin marketplace add mksglu/context-mode && /plugin install context-mode@context-mode

Etapa 2: Determinar Modo de Varredura

Verifique se .claude/pipeline/project-doc.md existe.

  • Não existe → VARREDURA COMPLETA (primeira execução)
  • Existe → VARREDURA DELTA

Etapa 3A: Varredura Completa

Use understand-anything para analisar toda a base de código. Se o context-mode estiver disponível (verificado na Etapa 1), roteie TODA a saída através de suas ferramentas (ctx_batch_execute / ctx_execute_file) — nunca despeje o conteúdo bruto dos arquivos na janela de contexto principal. Se o context-mode não estiver disponível, resuma as descobertas de cada arquivo inline e evite imprimir o conteúdo bruto dos arquivos.

Produza .claude/pipeline/project-doc.md usando a seguinte estrutura (baseada no padrão architecture-blueprint-generator):

# Project Documentation
> Generated: [timestamp] | Mode: FULL

## Tech Stack
- Runtime: [e.g. Node.js 20, Python 3.11]
- Language: [e.g. TypeScript, Python]
- Framework: [e.g. Next.js 14 App Router, FastAPI]
- Database: [e.g. PostgreSQL via Prisma]
- Styling: [e.g. Tailwind CSS]
- State Management: [e.g. Zustand, Redux]

## Dependencies
[Key libraries with versions, grouped by: core / dev / testing]

## Architecture Pattern
[e.g. Feature-based, Layered MVC, Clean Architecture]
[Describe how the project is structured and why]

## Folder Structure
[Top-level directory map with purpose of each folder]

## Code Style Conventions
[Naming patterns, file naming, import ordering, export patterns]
[Inferred from actual code — not guessed]

## Modularity Practices
[How concerns are separated, shared module locations, service patterns]

## Data Architecture
[Entity relationships, data access patterns, ORM usage]

## Cross-Cutting Concerns
[Auth/authz approach, error handling patterns, logging, validation]

## Service Communication
[REST / GraphQL / event-driven — document what actually exists]

## Test Coverage
- Overall coverage: [X%]
- Testing framework: [e.g. Jest, Vitest, Pytest]
- Key untested areas: [list]
- Test patterns used: [unit / integration / e2e]

## Entry Points
[Main files, key config files, environment setup]

## Changed Files
[Only present in delta scans — list of files re-scanned]

## Last Scanned
[ISO timestamp]

Após escrever project-doc.md, prossiga para a Etapa 4 para gerar AGENTS.md.

Etapa 3B: Varredura Delta

  1. Execute git diff HEAD~1 --name-only para obter os arquivos alterados
  2. Se não houver arquivos alterados, reporte "Nenhuma alteração detectada — project-doc.md está atualizado" e saia
  3. Use understand-anything para reanalisar apenas os arquivos alterados; roteie a saída através de ctx_execute_file se o context-mode estiver disponível, caso contrário, resuma inline
  4. Aplique patches apenas nas seções afetadas de .claude/pipeline/project-doc.md
  5. Atualize os campos Last Scanned e Changed Files
  6. Prossiga para a Etapa 4B (detecção de alteração arquitetural)

Etapa 4A: Gerar AGENTS.md (Apenas Primeira Execução)

Escreva AGENTS.md na raiz do repositório. Isso NÃO é uma cópia de project-doc.md — é reescrito como instruções para agentes, adaptado a este projeto específico. Todo agente lê este arquivo primeiro.

Antes de escrever AGENTS.md, leia e siga o modelo completo de instruções específicas do projeto, incluindo suas regras de segurança e requisitos de atualização confirmados por humanos.

…

Perguntas frequentes

O que são os arquivos gerados?

O `project-doc.md` é um resumo técnico do projeto (linguagem, dependências, estrutura). O `AGENTS.md` é um guia para outros agentes de IA entenderem e usarem o projeto.

O que acontece se eu não tiver as ferramentas extras?

O agente usa ferramentas básicas do sistema para fazer a análise, mas a documentação pode ser menos detalhada.

O que é um 'delta scan'?

É uma análise que verifica apenas as partes do código que foram modificadas desde a última vez que o agente foi executado, tornando o processo mais rápido.

Detalhes

Descrição original do autor

Scans the codebase to generate project-doc.md and AGENTS.md. Use when bootstrapping a new agent-driven repo, refreshing project documentation after architectural changes, or running a delta scan to detect drift. Runs a full scan on first use and a smart delta scan on subsequent runs. Uses understand-anything + context-mode when available, falls back to native tools otherwise. Only updates AGENTS.m

repo: wshobson/agents

Popularidade

Estrelas no GitHub
41 mil
Posição no ranking
#4953
Licença
MIT
Atualizada em
15/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas