docs-generator
Gera relatórios técnicos detalhados com base em análises. Útil para documentar resultados de testes de segurança e engenharia reversa.
O que ela faz
Este agente cria relatórios técnicos detalhados a partir de análises de segurança já concluídas. Ele organiza as informações de forma estruturada, como relatórios de engenharia reversa, testes de invasão e documentação de análise de assinaturas.
Quando usar
- ✓Após concluir uma análise de segurança e precisar de um relatório formal.
- ✓Quando é necessário padronizar a forma como os relatórios são escritos.
- ✓Se você pedir explicitamente para a IA 'escrever um relatório' ou 'criar um documento'.
Exemplo do que pedir para a IA
“Gere um relatório de teste de invasão com base nas descobertas recentes.”
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
Ele usa modelos pré-definidos para diferentes tipos de análise (como engenharia reversa ou teste de invasão) e organiza as informações coletadas. O relatório final é formatado de maneira clara e profissional.
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 docs-generatorOu baixe só o arquivo:
curl -L https://raw.githubusercontent.com/sickn33/agentic-awesome-skills/main/plugins/agentic-awesome-skills-claude/skills/docs-generator/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.
Suporte upstream incluído
Arquivos de suporte são incluídos em caminhos relativos à skill. Veja UPSTREAM-NOTICE.md para suas fontes fixadas, licenças, hashes e alterações de importação.
Documentação Técnica
Quando Usar
- Uma análise finalizada precisa de um relatório estruturado e compartilhável.
- Padronização de relatórios em múltiplos casos.
Documentação de Saída para Tarefas de Segurança/Engenharia Reversa
Quando tarefas de engenharia reversa/pentest/CTF/análise de segurança são concluídas, esta skill é responsável por gerar documentação técnica formal no diretório de projetos do usuário.
Gatilhos
- Tarefa de engenharia reversa concluída, com conclusões centrais produzidas (recuperação de algoritmo, quebra de assinatura, solução de bypass, etc.)
- Teste de penetração concluído, com vulnerabilidades descobertas e validadas
- CTF resolvido, com o flag obtido
- O usuário solicita explicitamente "escrever um relatório/documento/writeup"
Seleção de Modelo
| Tipo de Tarefa | Modelo a Usar |
|---|---|
| Engenharia Reversa de APK/Binário/so | references/security-report-templates.md → Relatório de Engenharia Reversa |
| Teste de Penetração/Descoberta de Vulnerabilidades | references/security-report-templates.md → Relatório de Teste de Penetração |
| Resolução de CTF | references/security-report-templates.md → Writeup de CTF |
| Engenharia Reversa de Assinatura JS/Web | references/security-report-templates.md → Relatório de Engenharia Reversa de Assinatura |
| Relatório de Análise de Malware / APT / Vírus | references/security-report-templates.md + references/vendor-report-rules.md |
| Documentação Técnica Geral | references/templates.md → README / Documentação de API |
Estrutura do Relatório do Fornecedor (Issue #65)
Relatórios formais de segurança DEVEM ler references/vendor-report-rules.md (apenas a estrutura, não o texto original do fornecedor). Selecione o sabor do fornecedor apenas quando as evidências da tarefa ou o usuário solicitarem explicitamente; use flavor = null para engenharia reversa comum e outras tarefas.
| Sabor / Overlay | Quando Usar | Esqueleto de Referência Principal |
|---|---|---|
malware |
Amostras de malware explícitas, trojans, white-hat-black-hat, envenenamento por phishing | Estilo H్ర绒: Visão Geral → Fluxo → Análise de Amostra → Resposta a Incidentes → IOC |
apt |
APT/Campanha/Grupo/Cadeia de Infecção Multi-Estágio/Direcionado por Setor | Estilo Kaspersky Securelist: Resumo → Cadeia de Infecção → Narrativa da Investigação → Descobertas Interessantes → Análise Técnica → Detecção e Mitigação → IOC |
flavor = null |
Engenharia Reversa comum de APK/ELF/PE/Mach-O, análise de algoritmo/firmware, pentest / CTF / engenharia reversa de assinatura JS | Modelo da Tarefa Original + Elementos Comuns Base; não aplique capítulos exclusivos de malware/APT |
thin vuln |
Análise técnica explícita de vulnerabilidade/patch/CVE solicitada pelo usuário | Visão Geral → Impacto/Reprodução → Análise de Crash e Patch → Recomendações de Proteção (sobreposto ao null, não o sabor padrão de corpo inteiro como o 3º) |
Princípio: Modelos são sobre qualidade, não quantidade — Apenas 2 sabores de corpo inteiro de fornecedor; vuln é apenas um overlay fino opcional, não crie um terceiro modelo padrão de corpo inteiro.
Efetivo simultaneamente com §0 Evidência→Descoberta→Caminho; em caso de conflito, o contrato de Evidência tem prioridade.
Especificações de Saída
- Local de Saída: Diretório do projeto atual do usuário (não o diretório do pacote da skill)
- Formato do Nome do Arquivo:
YYYY-MM-DD_[类型]-[目标简称]-report.md - Se o projeto tiver um diretório
docs/: Priorize colocá-lo emdocs/ - Codificação: UTF-8
- Idioma: Segue o idioma de diálogo do usuário (relatório em chinês para diálogo em chinês, relatório em inglês para diálogo em inglês)
Requisitos de Qualidade
- Todos os blocos de código devem ser executáveis diretamente ou ter contexto claro
- Não deve haver placeholders/TODOs
- Descobertas chave devem ter evidências de suporte
- Passos de reprodução devem permitir que terceiros reproduzam independentemente
- Informações sensíveis (tokens reais, senhas, URLs internas) devem ser substituídas por placeholders
- DEVE incluir a cadeia Evidência → Descoberta → Caminho (veja
../ops/evidence-finding-path.mde o modelo §0) - DEVE ler
references/vendor-report-rules.md: selecionemalware/aptouflavor = null(tarefas de vulnerabilidade podem ter o thinvulnsobreposto); sem sabor, apenas produza o modelo da tarefa original e os elementos Base aplicáveis, sem forçar IOC/ATT&CK - DEVE citar o caso
scope.md/timeline.md(scripts/case-init.ps1)
case-init.ps1 escreve scope.md, timeline.md, workitems.md e README.md sob work/<CaseName>/. Ele se recusa a executar quando esse diretório de caso já existe; escolha um novo -CaseName para preservar os dados de casos anteriores.
Integração de Gráficos
Ao gerar relatórios, chame a skill diagram-generator para gerar gráficos visuais em locais apropriados:
| Tipo de Relatório | Gráfico Sugerido | Tipo de Gráfico |
|---|---|---|
| Relatório de Engenharia Reversa | Gráfico de Relação de Chamada de Função, Gráfico de Fluxo de Dados | Mermaid flowchart / sequenceDiagram |
| Relatório de Teste de Penetração | Gráfico de Caminho de Ataque, Gráfico de Topologia de Rede | Mermaid flowchart / Graphviz |
| Writeup de CTF | Gráfico de Fluxo de Ideias de Resolução | Mermaid flowchart |
| Relatório de Engenharia Reversa de Assinatura JS | Gráfico de Sequência de Link de Requisição, Gráfico de Fluxo de Algoritmo | Mermaid sequenceDiagram / flowchart |
Os gráficos são incorporados ao markdown do relatório como blocos de código Mermaid, garantindo que possam ser renderizados diretamente no GitHub/GitLab.
Princípios Fundamentais
1. Divulgação Progressiva
Revele informações em camadas:
| Camada | Conteúdo | Pergunta do Usuário |
|---|---|---|
| 1 | Descrição de uma frase | O que é isso? |
| 2 | Bloco de código de início rápido | Como eu uso? |
| 3 | Referência completa da API | Quais são minhas opções? |
| 4 | Mergulho profundo na arquitetura | Como funciona? |
Avisos, alterações que quebram o código e pré-requisitos vão no TOPO.
2. Escrita Orientada a Tarefas
<!-- Bad: Feature-oriented -->
## AuthService Class
The AuthService class provides authentication methods...
<!-- Good: Task-oriented -->
## Authenticating Users
To authenticate a user, call login() with credentials:
3. Mostre, Não Apenas Diga
Todo conceito precisa de um exemplo concreto.
Padrões de Formatação
- Títulos em minúsculas: "Começando" em vez de "Começando"
- Máximo de 3 níveis de título: Mais profundo significa dividir o documento
- Sempre especifique o idioma em blocos de código
- Caminhos relativos para links internos
- Tabelas para dados estruturados com 3+ atributos
Checklist de Qualidade
- Exemplos de código testados e executáveis
- Nenhum texto placeholder ou TODO
- Corresponde ao comportamento real do código
- Escaneável sem ler tudo
- O leitor sabe o que fazer a seguir
Anti-Padrões
| Problema | Correção |
|---|---|
| Muro de texto | Divida com títulos, marcadores, código, tabelas |
| Informação crítica enterrada | Avisos/alterações que quebram o código no TOPO |
| Documentação de erro ausente | Sempre documente o que pode dar errado |
…
Perguntas frequentes
Onde o relatório será salvo?
O relatório será salvo no seu diretório de projeto atual, preferencialmente dentro de uma pasta 'docs/', se ela existir.
O relatório pode ser em português ou inglês?
Sim, o relatório será gerado no mesmo idioma em que você estiver conversando com a IA.
O que acontece se eu já tiver um relatório com o mesmo nome?
O sistema é projetado para criar novos relatórios com base nas informações mais recentes. Se um diretório de projeto já existir, ele pode pedir um novo nome para evitar sobrescrever dados antigos.
Detalhes
Descrição original do autor
Generate technical deliverables from completed analysis: reverse-engineering reports, penetration-test reports, CTF write-ups, and signature-analysis documentation with evidence-backed structure.
Popularidade
- Estrelas no GitHub
- 48 mil
- Posição no ranking
- #2865
- 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
intent-driven-development
Ajuda seu agente a transformar ideias em planos claros e testáveis. Define critérios para garantir que as mudanças sejam feitas corretamente e com segurança.
affaan-m/ECC
product-capability
Orienta seu agente a transformar ideias de produtos em planos claros. Define o que precisa ser feito, os limites e as decisões antes do desenvolvimento.
affaan-m/ECC
article-writing
Escreve conteúdos longos como artigos, guias e posts de blog com um estilo único. É útil quando você precisa de textos bem escritos, com voz consistente e credibilidade.
affaan-m/ECC