dg:Guia de preenchimento da Planilha de Doadores: mudanças entre as edições

De Documentação
mSem resumo de edição
mSem resumo de edição
Linha 88: Linha 88:


==== <code>donor_status</code>: a situação do relacionamento entre doador e o Instituto ====
==== <code>donor_status</code>: a situação do relacionamento entre doador e o Instituto ====
Valores possíveis [[https://github.com/digital-guard/preserv-BR/issues/83#issuecomment-1157820299 1]]:
Valores possíveis <sup>[[https://github.com/digital-guard/preserv-BR/issues/83#issuecomment-1157820299 1]]</sup>:


0 = Tentativas de contato realizadas;
0 = Doador em potencial sem contato realizado, ou com tentativas de contato sem resposta;


1 = Contatos com doadores potenciais que respondem ao nosso chamado;
1 = Doador potencial que respondeu ao chamado do representante do Instituto;


2 = Doadores efetivos: entregam alguma coisa mesmo que inútil;
2 = Doador efetivo, uma vez feita alguma entrega, independentemente da qualidade;


3 = Doadores com pacotes aprovados e publicados (''packs'').
3 = Doador efetivo com pacotes de dados aprovados e publicados (''packs'').


[[Categoria:Digital-guard]]
[[Categoria:Digital-guard]]

Edição das 01h14min de 30 de agosto de 2023

Este guia aborda o que é, qual é o conteúdo e explica o preenchimento da planilha de doadores.

Definição

A Planilha de Doadores donor.csv lista os dados principais das entidades que são potenciais doadores de pacotes de dados ao Instituto AddressForAll, em especial aos projetos AddressForAll e Digital Guard.

Há uma planilha desta por país, as quais são armazenadas nos repositórios do GitHub.

Uso

Os dados desta planilha são usados para identificar e informar sobre os doadores e dar-lhes atribuição (crédito ou autoria) em qualquer meio de armazenamento, publicação e distribuição do material que o Instituto venha a fazer.

Por exemplo, um software do Instituto usa os dados da planilha para adicionar os dados do doador no box de metadados dos pacotes armazenados no Digital Guard (exemplo).

Conteúdo

A planilha consiste do seguinte (da coluna esquerda para direita):

  • local_id: número de ID do doador;
  • scope_label: código da área de atuação do doador;
  • shortName: código ou nome curto do doador;
  • vat_id: número de cadastro de pessoa física ou jurídica do doador;
  • legalName: nome do doador;
  • wikidata_id: código identificador Wikidata;
  • url: endereço do site da entidade;
  • donor_date: data de inclusão do doador;
  • donor_status: a situação do relacionamento entre doador e o Instituto.

Preenchimento

Quando e quem preenche

Obrigatório: após a realização de contato entre um representante do Instituto (CRM) e o doador. O representante inclui o doador na planilha.

Opcional: quando é feita por decisão unilateral de um integrante do Instituto para um futuro contato ou por outro motivo.

Instruções de preenchimento

Estas são as instruções de preenchimento:

local_id: número de ID do doador

É dado por quem preenche no momento da inclusão do doador na planilha. O novo ID é o próximo número disponível para o país.

Exemplo: Se o último ID para a Colômbia foi 36, então o próximo ID será 37.

scope_label: área de atuação do doador

É um código que identifica área de atuação do doador, que pode ser o país, a subdivisão do país (estado ou província), ou o município (ou equivalente local).

Se a área de atuação é o país, será usado a sigla de 2 letras do país. Ver tabela, na coluna "Alpha-2 code".

Se a área é uma subdivisão do país, será usado a sigla composta da sigla do país e da subdivisão. Ver tabela, escolha o país na coluna "Entry".

Se a área é um município, o código é composto pelas sigla da subdivisão do país onde o município está, um hífen, e pelo nome do município sem espaços, acentos e preposições.

Caso o doador atua em mais de um município, sua área será a subdivisão do país pertinente. Se mais de uma subdivisão, sua área será o seu país.

Os códigos de país e suas subdivisões são dados pela norma ISO 3166-2 relacionada ao país. Caso precisar, há um link para esta norma no README do repositório de cada país no projeto Digital Guard no GitHub.

Exemplos:

  • O doador X, cuja área de atuação é o município de São José dos Pinhais, estado do Paraná, Brasil, seu código será BR-PR-SaoJosePinhais.
  • O doador Y, cuja área de atuação é o município de Tunja, departamento de Boyacá, Colômbia, seu código será CO-BOY-Tunja.
  • O doador Y, cuja área de atuação é a província de Entre Ríos, Argentina, seu código será AR-E.

shortName: nome curto

Edit-check-sheet.svg Tarefas: Verificar se ainda é necessário.

No caso de prefeituras, será o código de 2 letras do estado e o código de 3 letras do município. O código dos municípios do Brasil é dado por esta planilha: https://github.com/datasets-br/city-codes/blob/master/data/br-city-codes.csv, na coluna "abbrev3".

vat_id: número de cadastro da pessoa física ou jurídica

Argentina: CUIT; Brasil: CNPJ; Colômbia: NIT; Peru: RUC.

Pesquisar o número de cadastro pela Internet.

legalName: nome do doador

Nome do ente doador como se identifica.

wikidata_id: código de identificador Wikidata

O código é encontrado no site Wikidata, pela barra de pesquisa: https://www.wikidata.org/wiki/Wikidata:Main_Page

No caso de não haver um código, colocar , e pedir para um membro da equipe técnica criar.

O código é necessário para obter dados estruturados relevantes do ente.

url: endereço do site da entidade

Pesquisar o endereço principal do website da entidade pela Internet.

donor_date: data de inclusão do doador

Data de inclusão do doador na planilha no formato ano-mês-dia, exemplo 2023-08-29.

donor_status: a situação do relacionamento entre doador e o Instituto

Valores possíveis [1]:

0 = Doador em potencial sem contato realizado, ou com tentativas de contato sem resposta;

1 = Doador potencial que respondeu ao chamado do representante do Instituto;

2 = Doador efetivo, uma vez feita alguma entrega, independentemente da qualidade;

3 = Doador efetivo com pacotes de dados aprovados e publicados (packs).