cuducos / minha-receita

🏢 Sua API web para consulta de informações do CNPJ da Receita Federal
https://minhareceita.org
MIT License
1.32k stars 132 forks source link

Incluir alerta sobre qualidade de dados públicos #143

Closed jedibruno closed 2 years ago

jedibruno commented 2 years ago

Nossa experiência mostra que nem sempre bases de dados públicos estão imunes a problemas. Dados podem estar desatualizados, incorretos, incompletos ou simplesmente estranhos. Alertar o usuário pode ser importante, não só para fins de transparência e usabilidade como também para coletar esses problemas e requerer correções/melhorias na fonte:

Sugestões:

  1. Incluir alerta de que dados públicos não necessariamente pode estar corretos;

  2. Criar canal (email, etc) para pessoas mandarem alertas sobre entradas incorretas ou estranhas;

cuducos commented 2 years ago

Incluir alerta de que dados públicos não necessariamente pode estar corretos

Perfeito. Alguma sugestão de redação que podemos por em https://docs.minhareceita.org?

Criar canal (email, etc) para pessoas mandarem alertas sobre entradas incorretas ou estranhas

Isso estou em um pouco em dúvida. Como funcionaria?

jedibruno commented 2 years ago

Algo no estilo:

Ressalva importante: os dados estão constantes na API estão disponibilizados tal como foram publicados pela Receita Federal. Em nossa experiência utilizando dados públicos, isso significa que esses dados podem conter problemas que vão desde: a) desatualização; b) incorreção; c) incompletude; d) inconsistência. Como somos apenas uma fonte secundária para os dados, não temos como identificar ou corrigir esses problemas, então tenha isso em mente quando for utilizar a API.

Quando localizamos problemas na base de dados, buscamos requerer via protocolo no FalaBR a correção deles. Caso queira nos ajudar com isso, nos avise quando localizar algum problema nos dados, indicando: a) qual o problema localizado; b) quando localizou; c) como localizou este problema. Isso nos permite alertar formalmente a RFB sobre a questão para que tomem as medidas necessárias para corrigir os dados.

Acho que o Github pode ser esse canal, sim. A ideia é coletar esses problemas para ir solicitando correções e melhorias na base.

cuducos commented 2 years ago

Fechado por #144