Publicar dados abertos compreensíveis e documentados

Tempo estimado de leitura: 3 min. · Publicado em 1º de outubro de 2026

Estabeleça proveniência e escopo

Descreva o produtor, o método de coleta, o período de tempo e a cobertura geográfica ou temática. Distinguir as datas de extração, atualização e medição. Um arquivo publicado hoje pode descrever uma medição anterior; A publicação não altera seu ano de referência.

Declare áreas ausentes e valores aproximados onde a fonte as identifica. Não preencha uma lacuna com uma estimativa não revelada. A orientação de documentação do Data.Gouv.fr aborda o contexto de produção, a estrutura e as possíveis inconsistências.

Forneça um dicionário e um exemplo

Explique cada campo, unidade, tipo, valor ausente e código de referência. Forneça um pequeno exemplo legível consistente com o conjunto de dados completo. Onde os identificadores ingressam em tabelas, documentos de relacionamento e linhas potencialmente incomparáveis.

Distinguir entidades de seus rótulos. Um município pode ter vários códigos postais e um produto de várias variantes. A documentação deve ajudar a evitar uma agregação enganosa ou desduplicação que remova um relacionamento útil.

Verifique a publicação e reutilize

Identifique as condições de reutilização da fonte e as informações de atribuição a serem retidas. Peça aos revisores apropriados a avaliarem os direitos de publicação e os possíveis dados pessoais antes da divulgação pública. Um endereço visível em outro lugar não torna automaticamente todas as cópias adequadas para publicação.

Teste os downloads sem ferramentas internas ou contas especiais quando o acesso público for prometido. Verifique o formato, codificação e integridade. Forneça uma referência de versão ou uma soma de verificação para que o feedback possa ser vinculado ao arquivo baixado.

Manter versões e correções

Escolha uma frequência de revisão realista e um contato para problemas. Descreva campos adicionados, removidos ou redefinidos quando os esquemas mudam. Distinguir correções de novas medições para evitar a criação de alterações falsas em uma série temporal.

Mantenha versões e notas úteis com uma política de substituição clara. A documentação da publicação deve permitir que outra pessoa reproduza a extração ou entenda suas limitações. Um contador de download não substitui a qualidade da documentação.

Documentação principal: data.gouv.fr — documentar um conjunto de dados com cuidado.

Documentos de referência

data.gouv.fr — documentar um conjunto de dados com cuidado

Conteúdo atualizado em 1º de outubro de 2026

Registe as verificações e os resultados no registo de testes web

Matriz de validação funcional para se adaptar ao projeto

Esses controles propostos usam casos fictícios. Decida qual comportamento é esperado com a equipe, anote o resultado e atribua discrepâncias não resolvidas antes da publicação.

Casos de teste, resultados esperados e evidências úteis
Caso	Resultado esperado	Prova para guardar
Download público anunciado	Uma pessoa externa obtém um arquivo legível sem ferramentas internas.	Endereço, formato, tamanho e abertura de sucesso em um leitor comum.
Campo e unidade verificados	O exemplo e o arquivo completo usam a mesma definição.	Dicionário, amostra e comparação de valores conhecidos em ambas as representações.
Identificador desconhecido e incomparável	As limitações permanecem visíveis sem substituir um valor plausível.	Linhas afetadas e regras documentadas para representar informações desconhecidas ou incomparáveis.
Correção publicada	Um reutilizador pode distinguir uma correção de uma nova medição.	Versão, descrição da mudança e datas de referência mantidas com o arquivo publicado.

Perguntas frequentes

Qual data deve acompanhar um arquivo?

Quando relevante, mostre a extração, última modificação e período coberto como datas nomeadas separadamente. Não apresente automaticamente o tempo de download como o ano de referência de uma população ou outra medida.

Uma licença por si só torna os dados utilizáveis?

Ele define as condições de reutilização, mas campos, unidades, identificadores, cobertura, qualidade e versões também precisam de explicação. Outra pessoa deve ser capaz de reproduzir ou pelo menos entender o uso.