Pesquisar
Introduza pelo menos dois caracteres, sem dados pessoais.

    BibliotecaArtigos e FAQs Seu projetoSolicite um orçamento
    LínguaPT ▾
    Guias práticos

    Publicar dados abertos compreensíveis e documentados

    Os dados para download ainda não são dados compreensíveis. Um reutilizador precisa saber quem o produziu, o que cobre, o que exclui e como interpretar seus campos.

    Veja o método

    Ilustração — Publicar dados abertos compreensíveis e documentados
    Ilustração gerada por IA

    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.

    Nos dados geográficos, documente o referencial e a ordem das coordenadas, não só o formato. A RFC 7946 define GeoJSON com WGS 84 e graus decimais; os dois primeiros valores são longitude e latitude. No exercício fictício, Point [2.35,48.86] não deve tornar-se [48.86,2.35]. Ambos os arrays são JSON legível com valores plausíveis: validar apenas a sintaxe não deteta a inversão.

    Distinga uma entidade não localizada de um ponto conhecido. Numa Feature GeoJSON não localizada, geometry pode ser null; isso não equivale a um Point com coordenadas nulas nem a substituir o desconhecido por [0,0], uma posição real. Descreva também entrada observada, morada geocodificada ou centro calculado, com proveniência e data. Mais casas decimais não tornam uma estimativa mais certa.

    Desloque a tabela horizontalmente para ler todas as colunas. Com o teclado, coloque o foco na tabela e utilize as teclas de seta.

    Exercício fictício: verificar o sentido além do JSON legível
    CasoInterpretaçãoVerificação útil
    Point · coordinates: [2.35,48.86]Longitude 2.35; latitude 48.86Comparar com os campos nomeados da fonte
    Point · coordinates: [48.86,2.35]Números plausíveis, invertidos neste exercícioVerificar o sentido; a sintaxe não basta
    Feature · geometry: nullEntidade não localizada; fragmento de estruturaDocumentar a ausência sem inventar um ponto
    Posição [0,0]Coordenadas existentes, não ausênciaNão substituir automaticamente um valor desconhecido

    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 : Bien documenter un jeu de données.

    Distinga o conjunto de dados das suas distribuições. Um CSV e um JSON podem representar o mesmo conjunto em dois formatos; não os conte automaticamente como duas medições independentes. DCAT descreve uma distribuição como uma representação específica do conjunto. Compare cobertura, precisão, campos e versão: duas distribuições não são necessariamente equivalentes sem perda de informação.

    Acrescente um identificador de versão e um histórico das correções. Um endereço de «última versão» pode manter-se estável, mas deve ser possível identificar a versão efetivamente usada. Distinga ainda correção e nova observação: medir um novo mês não corrige, por si só, o anterior. Explique a relação entre versões e séries antes de comparar os números.

    Desloque a tabela horizontalmente para ler todas as colunas. Com o teclado, coloque o foco na tabela e utilize as teclas de seta.

    Publicação de dados: identificar objeto, formato e revisão
    Elemento documentalO que distingueVerificação útil
    Conjunto de dadosTema, âmbito e observações descritas.A identidade permanece compreensível independentemente do formato do ficheiro.
    Distribuição CSV ou JSONUma representação específica do conjunto.Comparar campos, precisão e cobertura antes de pressupor equivalência.
    Versão identificadaUm estado preciso e o histórico de alterações.Encontrar a versão citada mesmo que um endereço atual tenha sido atualizado.
    Correção ou novo períodoUm valor revisto ou uma observação diferente.Não apresentar um novo mês como correção automática do anterior.

    Documentos de referência

    Conteúdo atualizado

    Referências documentadas para este tema

    Referências documentadas para este tema
    ReferênciaValor ou sintaxeÂmbito
    RFC 4180 · CSV
    text/csv · "a,b"Campos com vírgulas, aspas ou quebras de linha usam aspas; as aspas internas são duplicadas.
    RFC 8259 · JSON
    application/json · UTF-8JSON padrão não admite comentários nem vírgulas finais; as cadeias usam aspas duplas.

    As datas indicam a consulta das fontes. Estes dados não constituem uma auditoria do site nem uma declaração global de conformidade.

    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.

    Desloque a tabela horizontalmente para ler todas as colunas. Com o teclado, coloque o foco na tabela e utilize as teclas de seta.

    Casos de teste, resultados esperados e evidências úteis
    CasoResultado esperadoProva para guardar
    Download público anunciadoUma 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 verificadosO 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ávelAs 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 publicadaUm 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.