Tempo de leitura estimado : 5 min · Publicado
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.
| Caso | Interpretação | Verificação útil |
|---|---|---|
| Point · coordinates: [2.35,48.86] | Longitude 2.35; latitude 48.86 | Comparar com os campos nomeados da fonte |
| Point · coordinates: [48.86,2.35] | Números plausíveis, invertidos neste exercício | Verificar o sentido; a sintaxe não basta |
| Feature · geometry: null | Entidade não localizada; fragmento de estrutura | Documentar a ausência sem inventar um ponto |
| Posição [0,0] | Coordenadas existentes, não ausência | Nã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.
| Elemento documental | O que distingue | Verificação útil |
|---|---|---|
| Conjunto de dados | Tema, âmbito e observações descritas. | A identidade permanece compreensível independentemente do formato do ficheiro. |
| Distribuição CSV ou JSON | Uma representação específica do conjunto. | Comparar campos, precisão e cobertura antes de pressupor equivalência. |
| Versão identificada | Um 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íodo | Um valor revisto ou uma observação diferente. | Não apresentar um novo mês como correção automática do anterior. |
- W3C DCAT 3 : Distribuições
Consultado em 22 de outubro de 2026; conjuntos, representações e possíveis diferenças de fidelidade.
- W3C : Dados na Web e versões
Consultado em 22 de outubro de 2026; identificadores de versão, histórico e observações de períodos diferentes.
Documentos de referência
- W3C : Dados na Web práticas recomendadas · Fonte consultada
- IETF : GeoJSON RFC 7946 · Fonte consultada
- data.gouv.fr : Bien documenter un jeu de données
Conteúdo atualizado
Referências documentadas para este tema
| Referência | Valor 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-8 | JSON 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.
