🔍
ChatGPT intermediate

Prompt para documentação em consultas sql em Consultas SQL

Prompt gerado automaticamente para Documentação em Consultas SQL em Consultas SQL

4 usos Consultas SQL

Prompt completo

**Prompt:**

"Você é um engenheiro de dados sênior e fluente em SQL, com vasta experiência em documentação técnica. Sua tarefa é criar um modelo de documentação conciso e eficaz para consultas SQL complexas, visando facilitar a manutenção, depuração e compreensão por outros desenvolvedores, mesmo aqueles que não participaram da criação original da consulta.

O modelo deve ser aplicável a uma consulta SQL hipotética de médio porte (aproximadamente 30-50 linhas), que envolva `JOINs` múltiplos, `WHERE` clauses complexas, subconsultas e talvez uma função de agregação.

Crie um prompt detalhado para um modelo de linguagem de IA (como você), instruindo-o a gerar essa documentação. O prompt deve incluir os seguintes elementos:

1.  **Título da Documentação:** Um título claro e descritivo para o documento gerado.
2.  **Seção de Propósito/Objetivo:** Uma explicação do que a consulta faz e qual problema de negócio ela resolve.
3.  **Seção de Entradas/Parâmetros (se aplicável):** Se a consulta usar variáveis ou parâmetros, como eles devem ser descritos.
4.  **Seção de Saídas/Resultados Esperados:** Uma descrição do formato dos dados de saída e o que cada coluna representa.
5.  **Seção de Lógica de Negócio Detalhada:** Esta é a parte mais importante. Como a IA deve descrever, passo a passo, a lógica da consulta? Inclua instruções para:
    *   Explicar cada `JOIN` e o propósito da união.
    *   Detalhar as condições de filtro (`WHERE` clauses) e por que são usadas.
    *   Explicar o papel de subconsultas ou CTEs (Common Table Expressions).
    *   Descrever funções de agregação, se houver.
    *   Mencionar tabelas e colunas críticas envolvidas.
6.  **Seção de Considerações de Performance (opcional, mas desejável):** Instruções para a IA identificar potenciais gargalos ou otimizações.
7.  **Seção de Exemplos de Uso (opcional, mas desejável):** Como a IA pode fornecer exemplos de como a consulta pode ser executada ou modificada.
8.  **

Tags relacionadas

Consultas SQL Documentação em Consultas SQL gerado-automaticamente

Como usar este prompt

1

Clique no botão "Copiar" para copiar o prompt para sua área de transferência

2

Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)

3

Cole o prompt e adapte conforme necessário para seu contexto específico