c4-code
Faz seu agente analisar diretórios de código para criar documentação C4 no nível do código. Ele detalha funções, argumentos, dependências e a estrutura do código.
O que ela faz
Esta ferramenta analisa pastas de código para criar documentação detalhada sobre como as funções e classes estão organizadas, quais dados elas usam e como se conectam umas às outras. Ela ajuda a entender a estrutura interna de um programa.
Quando usar
- ✓Ao começar a trabalhar em uma nova parte do código.
- ✓Quando você precisa entender como uma seção específica do código funciona.
- ✓Ao documentar um projeto para outros desenvolvedores.
Exemplo do que pedir para a IA
“Documente a pasta 'utils' do projeto, mostrando as funções, seus parâmetros e dependências.”
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
Mensagem pronta para colar
Como funciona
A ferramenta examina os arquivos de código na pasta especificada. Ela identifica funções, classes, seus parâmetros, o que elas retornam e quais outras partes do código elas utilizam. Em seguida, organiza essas informações de forma clara.
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 sickn33/agentic-awesome-skills --skill c4-codeOu baixe só o arquivo:
curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/c4-code/SKILL.md -o SKILL.mdConteúdo técnico (SKILL.md)
Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.
Nível de Código C4: [Nome do Diretório]
Use esta habilidade quando
- Trabalhando em tarefas ou fluxos de trabalho do nível de código C4: [nome do diretório]
- Precisando de orientação, melhores práticas ou listas de verificação para o nível de código C4: [nome do diretório]
Não use esta habilidade quando
- A tarefa não estiver relacionada ao nível de código C4: [nome do diretório]
- Você precisar de um domínio ou ferramenta diferente fora deste escopo
Instruções
- Clarifique objetivos, restrições e entradas necessárias.
- Aplique as melhores práticas relevantes e valide os resultados.
- Forneça etapas acionáveis e verificação.
Visão Geral
- Nome: [Nome descritivo para este diretório de código]
- Descrição: [Breve descrição do que este código faz]
- Localização: [Link para o caminho real do diretório]
- Linguagem: [Linguagem(ns) de programação principal(is)]
- Propósito: [O que este código realiza]
Elementos de Código
Funções/Métodos
functionName(param1: Type, param2: Type): ReturnType- Descrição: [O que esta função faz]
- Localização: [caminho do arquivo:número da linha]
- Dependências: [do que esta função depende]
Classes/Módulos
ClassName- Descrição: [O que esta classe faz]
- Localização: [caminho do arquivo]
- Métodos: [lista de métodos]
- Dependências: [do que esta classe depende]
Dependências
Dependências Internas
- [Lista de dependências de código internas]
Dependências Externas
- [Lista de bibliotecas, frameworks, serviços externos]
Relacionamentos
Diagramas opcionais de Mermaid para estruturas de código complexas. Escolha o tipo de diagrama com base no paradigma de programação. Diagramas de código mostram a estrutura interna de um único componente.
Código Orientado a Objetos (Classes, Interfaces)
Use classDiagram para código OOP com classes, interfaces e herança:
---
title: Code Diagram for [Component Name]
---
classDiagram
namespace ComponentName {
class Class1 {
+attribute1 Type
+method1() ReturnType
}
class Class2 {
-privateAttr Type
+publicMethod() void
}
class Interface1 {
<<interface>>
+requiredMethod() ReturnType
}
}
Class1 ..|> Interface1 : implements
Class1 --> Class2 : uses
### Functional/Procedural Code (Modules, Functions)
For functional or procedural code, you have two options:
**Option A: Module Structure Diagram** - Use `classDiagram` to show modules and their exported functions:
```mermaid
---
title: Estrutura do Módulo para [Nome do Componente]
---
classDiagram
namespace ProcessamentoDados {
class validadores {
<<module>>
+validarEntrada(dados) Resultado~Dados, Erro~
+validarEsquema(esquema, dados) bool
+sanitizar(entrada) string
}
class transformadores {
<<module>>
+parseJSON(bruto) Registro
+normalizar(dados) DadosNormalizados
+agregar(itens) Resumo
}
class io {
<<module>>
+lerArquivo(caminho) string
+escreverArquivo(caminho, conteudo) void
}
}
transformadores --> validadores : usa
transformadores --> io : lê de
```
**Option B: Data Flow Diagram** - Use `flowchart` to show function pipelines and data transformations:
```mermaid
---
title: Pipeline de Dados para [Nome do Componente]
---
flowchart LR
subgraph Entrada
A[lerArquivo]
end
subgraph Transformação
B[parseJSON]
C[validarEntrada]
D[normalizar]
E[agregar]
end
subgraph Saída
F[escreverArquivo]
end
A -->|string bruta| B
B -->|dados analisados| C
C -->|dados válidos| D
D -->|normalizado| E
E -->|resumo| F
```
**Option C: Function Dependency Graph** - Use `flowchart` to show which functions call which:
```mermaid
---
title: Dependências de Função para [Nome do Componente]
---
flowchart TB
subgraph API Pública
processarDados[processarDados]
exportarRelatorio[exportarRelatorio]
end
subgraph Funções Internas
validar[validar]
transformar[transformar]
formatar[formatar]
cache[memoizar]
end
subgraph Utilitários Puros
compor[compor]
encadear[encadear]
curry[curry]
end
processarDados --> validar
processarDados --> transformar
processarDados --> cache
transformar --> compor
transformar --> encadear
exportarRelatorio --> formatar
exportarRelatorio --> processarDados
```
### Escolhendo o Diagrama Correto
…
Perguntas frequentes
O que é 'C4 Code-level'?
É uma forma de documentar o código focando nos detalhes internos, como funções e classes, para ajudar a entender a estrutura de um componente específico.
Que tipo de diagramas ela pode criar?
Ela pode criar diagramas de classes para código orientado a objetos e diagramas de fluxo ou estrutura de módulos para código funcional/procedural, dependendo do estilo do código.
Preciso saber sobre o modelo C4 para usar esta ferramenta?
Não necessariamente. A ferramenta foca nos detalhes do código, que é um nível do modelo C4, mas você não precisa ser um especialista no modelo para usá-la.
Detalhes
Descrição original do autor
Expert C4 Code-level documentation specialist. Analyzes code directories to create comprehensive C4 code-level documentation including function signatures, arguments, dependencies, and code structure.
Popularidade
- Estrelas no GitHub
- 48 mil
- Posição no ranking
- #2484
- Licença
- MIT
- Atualizada em
- 15/10/2026
Comentários
- …
Mais skills deste repositório
00-andruia-consultant
Ajuda seu agente a iniciar ou melhorar projetos de IA. Ele analisa código, sugere ferramentas e cria planos de ação em espanhol.
sickn33/agentic-awesome-skills
007
Faz seu agente realizar auditorias de segurança e modelagem de ameaças. É útil para proteger projetos contra ataques e vulnerabilidades.
sickn33/agentic-awesome-skills
10-andruia-skill-smith
Ajuda seu agente a criar ou melhorar ferramentas de IA. Ele define como as ferramentas funcionam, escreve a documentação e valida a estrutura.
sickn33/agentic-awesome-skills
20-andruia-niche-intelligence
Faz seu agente criar um resumo sobre um setor específico. É útil para entender o contexto, regras, padrões de uso e riscos de um projeto, usando fontes confiáveis.
sickn33/agentic-awesome-skills
Skills parecidas
architecture-decision-records
Faz seu agente registrar decisões importantes sobre a estrutura do projeto. Ajuda a entender o porquê das escolhas feitas e a manter um histórico claro das mudanças.
affaan-m/ECC
code-tour
Faz seu agente criar guias passo a passo no código, com locais exatos em arquivos e linhas. É útil para apresentar um projeto, explicar código ou revisar mudanças. Ajuda a entender como um sistema funciona.
affaan-m/ECC
codebase-onboarding
Ajuda seu agente a analisar um código desconhecido e criar um guia de integração. Ele inclui um mapa da arquitetura, pontos de entrada e convenções. Ideal para quem está começando em um novo projeto.
affaan-m/ECC