🔍
ChatGPT intermediate

Como documentar documentação em consultas sql em Consultas SQL

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

3 usos Consultas SQL

Prompt completo

Crie um guia interativo e prático (passo a passo, com exemplos de código SQL e explicações claras) sobre as melhores práticas para documentar consultas SQL complexas. O guia deve abordar:

1.  **Por que documentar:** Os benefícios de uma boa documentação (manutenibilidade, colaboração, auditoria, etc.).
2.  **Onde documentar:** Comentários dentro do código (inline e block), READMEs de projetos, wikis, ferramentas de versionamento de banco de dados (Flyway, Liquibase).
3.  **O que documentar:**
    *   **Propósito da consulta:** O que ela faz e por que foi criada.
    *   **Entradas/Parâmetros:** Se a consulta depende de valores externos.
    *   **Saídas:** Estrutura das colunas retornadas e o significado de cada uma.
    *   **Lógica de negócio:** Regras específicas aplicadas (filtros complexos, cálculos, junções).
    *   **Tabelas envolvidas:** Nomes e alias utilizados.
    *   **Considerações de performance:** Indexação, otimizações.
    *   **Dependências:** Outras consultas, views, stored procedures.
    *   **Autor e Data:** Quem criou/modificou e quando.
    *   **Histórico de Revisões:** Pequenas notas sobre mudanças significativas.
4.  **Como documentar:**
    *   **Padrões de comentários:** Estilos recomendados (ex: `--`, `/* */`).
    *   **Linguagem clara e concisa:** Evitar jargões desnecessários, preferir português ou inglês técnico padrão.
    *   **Exemplos de templates:** Estruturas predefinidas para facilitar a escrita.
    *   **Uso de pseudocódigo ou explicações lógicas:** Para trechos muito complexos.
5.  **Ferramentas e Automação:** Breve menção a ferramentas que podem auxiliar na geração ou manutenção de documentação (geradores de esquema, ferramentas de data lineage).

O guia deve ser formatado para ser facilmente consumível por desenvolvedores SQL de diferentes níveis, desde iniciantes a seniores, e ser otimizado para busca e referência rápida. Inclua um pequeno "mini-quiz" no final

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