🐘
ChatGPT intermediate

Guia para documentação em postgresql em PostgreSQL

Prompt gerado automaticamente para Documentação em PostgreSQL em PostgreSQL

4 usos PostgreSQL

Prompt completo

"Você é um especialista em PostgreSQL com vasto conhecimento em documentação técnica. Sua tarefa é criar um guia interativo e passo a passo para a comunidade de desenvolvedores e DBAs, que cubra o processo completo de como documentar eficientemente uma base de dados PostgreSQL existente, focando em:

1. **Descoberta e Extração de Metadados:** Quais ferramentas e comandos (nativos do PostgreSQL ou de terceiros, se relevantes) podem ser usados para extrair informações sobre schemas, tabelas, colunas (tipos, nulabilidade, defaults), índices, visões, funções, procedures, triggers e restrições (PK, FK, UNIQUE, CHECK). Inclua exemplos práticos de `psql` e `information_schema`.
2. **Organização e Estrutura da Documentação:** Proponha uma estrutura lógica e padronizada para organizar essa documentação, considerando diferentes níveis de detalhe (visão geral, detalhes da tabela, detalhes da coluna, etc.). Sugira formatos (Markdown, HTML, YAML, JSON) e ferramentas de versionamento (Git).
3. **Geração Automatizada vs. Documentação Manual:** Discuta os prós e contras de abordagens automatizadas (geradores de documentação de schema) versus contribuições manuais. Quando usar cada uma? Exemplifique com ferramentas populares (ex: `pg_dump --schema-only`, ferramentas de ERD, ou geradores de documentação como `SchemaSpy` se aplicável).
4. **Manutenção e Atualização Contínua:** Como garantir que a documentação permaneça atualizada com as mudanças no esquema? Proponha estratégias de CI/CD para automatizar a atualização da documentação, ou processos para revisões periódicas.
5. **Boas Práticas e Recomendações:** Inclua dicas sobre como tornar a documentação clara, concisa, pesquisável e útil para diferentes públicos (desenvolvedores, analistas de dados, DBAs júnior). Aborde a importância de comentários em objetos de banco de dados (`COMMENT ON...`).

O guia deve ser prático, com exemplos de código, e focado em soluções que possam ser implementadas por equipes de diferentes tamanhos, visando reduzir a dependência do conhecimento tácito e facilitar o onboarding de novos membros."

Tags relacionadas

PostgreSQL Documentação em PostgreSQL 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