dg:Guia de preenchimento da Planilha de Doadores: mudanças entre as edições
Sem resumo de edição |
|||
(24 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) | |||
Linha 1: | Linha 1: | ||
{{Para|a versão planilha de pacotes|dg:Guia de preenchimento da Planilha de Pacotes|Guia de preenchimento da Planilha de Pacotes}} | |||
Este guia aborda o que é, qual é o conteúdo e explica o preenchimento da planilha de doadores. | Este guia aborda o que é, qual é o conteúdo e explica o preenchimento da planilha de doadores. | ||
== Definição == | == Definição == | ||
A '''Planilha de Doadores''' <code>donor.csv</code> lista os dados principais das entidades que são potenciais doadores de pacotes de dados ao [[Instituto AddressForAll]], em especial aos projetos [[Documentação AddresForAll|AddressForAll]] e [[Documentação Digital-guard|Digital Guard]]. | A '''Planilha de Doadores''' <code>donor.csv</code> lista os dados principais das entidades que são potenciais doadores de pacotes (ver [[dg:Guia de preenchimento da Planilha de Pacotes|guia]]) de dados ao [[Instituto AddressForAll]], em especial aos projetos [[Documentação AddresForAll|AddressForAll]] e [[Documentação Digital-guard|Digital Guard]]. | ||
Há uma planilha desta por país, as quais são armazenadas nos [https://git.digital-guard.org repositórios do GitHub]. | Há uma planilha desta por país, as quais são armazenadas nos [https://git.digital-guard.org repositórios do GitHub]. | ||
Linha 17: | Linha 19: | ||
A planilha consiste do seguinte (da coluna esquerda para direita): | A planilha consiste do seguinte (da coluna esquerda para direita): | ||
* <code>local_id</code>: | *<code>local_id</code>: número de ID do doador; | ||
*<code>scope_label</code>: | *<code>scope_label</code>: código da área de atuação do doador; | ||
*<code> | *<code>vat_id</code>: número de cadastro de pessoa física ou jurídica do doador; | ||
*<code>legalName</code>: nome do doador; | |||
*<code>legalName</code>: | *<code>wikidata_id</code>: código identificador Wikidata; | ||
*<code>wikidata_id</code>: | |||
*<code>url</code>: endereço do site da entidade; | *<code>url</code>: endereço do site da entidade; | ||
*<code>donor_date</code>: data de inclusão do doador; | *<code>donor_date</code>: data de inclusão do doador; | ||
Linha 37: | Linha 38: | ||
Estas são as instruções de preenchimento: | Estas são as instruções de preenchimento: | ||
==== <code>local_id</code>: | ==== <code>local_id</code>: número de ID do doador ==== | ||
É dado por quem preenche no momento da inclusão na planilha | É 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. | |||
==== <code>scope_label</code>: área de atuação do doador ==== | |||
É um código que identifica área de atuação do doador, que pode ser um país, uma subdivisão do país (estado ou província), ou um município (ou equivalente local). | |||
Se a área de atuação é o país, será usado a sigla de 2 letras do país. Caso precisar, ver [[wikipedia:ISO_3166-1#Current_codes|esta 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. Caso precisar, ver [[wikipedia:ISO_3166-2#Current_codes|esta tabela]], escolha o país na coluna "Entry" para obter uma lista completa de códigos para as subdivisões do país. | |||
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 [https://github.com/digital-guard Digital Guard no GitHub]. | |||
''Exemplos'': | |||
* Uma prefeitura que atua no município de São José dos Pinhais, estado do Paraná, Brasil, seu código será <code>BR-PR-SaoJosePinhais</code>. | |||
* Uma prefeitura que atua no município de Tunja, departamento de Boyacá, Colômbia, seu código será <code>CO-BOY-Tunja</code>. | |||
* Uma companhia de água que atua no estado do Pará, Brasil, seu código será <code>BR-PA</code>. | |||
* Um instituto que atua na província de Entre Ríos, Argentina seu código será <code>AR-E</code>. | |||
* Uma entidade que atua no Peru seu código será <code>PE</code>. | |||
==== <code> | ==== <code>vat_id</code>: 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. | |||
==== <code>legalName</code>: nome do doador ==== | ==== <code>legalName</code>: nome do doador ==== | ||
Nome do doador como se identifica. | Nome do ente doador como ele se identifica. | ||
==== <code>wikidata_id</code>: código de identificador Wikidata ==== | ==== <code>wikidata_id</code>: código de identificador Wikidata ==== | ||
O código é encontrado no site Wikidata, pela barra de pesquisa: https://www.wikidata.org/wiki/Wikidata:Main_Page | O código é encontrado no site Wikidata, pela barra de pesquisa: https://www.wikidata.org/wiki/Wikidata:Main_Page | ||
==== <code>url</code>: endereço do site da entidade | No caso de não haver um código, deixar em branco e pedir para um membro da equipe técnica criar um ID na Wikidata. | ||
O código é necessário para obter dados estruturados relevantes do ente doador. | |||
==== <code>url</code>: endereço do site da entidade ==== | |||
Pesquisar o endereço principal do website da entidade pela Internet. | Pesquisar o endereço principal do website da entidade pela Internet. | ||
==== donor_date: data de inclusão do doador ==== | ==== <code>donor_date</code>: data de inclusão do doador ==== | ||
Data de inclusão do doador na planilha | Data de inclusão do doador na planilha. | ||
==== <code>donor_status</code>: a situação do relacionamento entre doador e o Instituto ==== | |||
Valores possíveis: | |||
0 = Doador em potencial sem contato realizado, ou com tentativas de contato sem resposta - indica que ainda precisa ser feito contato; | |||
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''). | |||
== Ver também == | |||
* [[dg:Guia de preenchimento da Planilha de Pacotes]] | |||
[[Categoria:Digital-guard]] | [[Categoria:Digital-guard]] | ||
[[Categoria:Manuais]] |
Edição atual tal como às 04h12min de 22 de setembro de 2023
- Nota: Para a versão planilha de pacotes, ver Guia de preenchimento da Planilha de Pacotes
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 (ver guia) 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.
- Exemplo de Planilha de Doadores: https://git.digital-guard.org/digital-guard/preserv-BR/blob/main/data/donor.csv
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;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 um país, uma subdivisão do país (estado ou província), ou um município (ou equivalente local).
Se a área de atuação é o país, será usado a sigla de 2 letras do país. Caso precisar, ver esta 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. Caso precisar, ver esta tabela, escolha o país na coluna "Entry" para obter uma lista completa de códigos para as subdivisões do país.
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:
- Uma prefeitura que atua no município de São José dos Pinhais, estado do Paraná, Brasil, seu código será
BR-PR-SaoJosePinhais
. - Uma prefeitura que atua no município de Tunja, departamento de Boyacá, Colômbia, seu código será
CO-BOY-Tunja
. - Uma companhia de água que atua no estado do Pará, Brasil, seu código será
BR-PA
. - Um instituto que atua na província de Entre Ríos, Argentina seu código será
AR-E
. - Uma entidade que atua no Peru seu código será
PE
.
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 ele 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, deixar em branco e pedir para um membro da equipe técnica criar um ID na Wikidata.
O código é necessário para obter dados estruturados relevantes do ente doador.
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.
donor_status
: a situação do relacionamento entre doador e o Instituto
Valores possíveis:
0 = Doador em potencial sem contato realizado, ou com tentativas de contato sem resposta - indica que ainda precisa ser feito contato;
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).