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

De Documentação
Sem resumo de edição
 
(32 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):


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


== Preenchimento ==
== Preenchimento ==
=== Quem preenche ===
=== Quando e quem preenche ===
Ela deve ser preenchida após a realização de contato entre um representante do Instituto AddressForAll.
'''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 ===
=== Instruções de preenchimento ===
Linha 35: Linha 38:
Estas são as instruções de preenchimento:
Estas são as instruções de preenchimento:


==== local_id: Número de ID ====
==== <code>local_id</code>: número de ID do doador ====
É dado por quem preenche no momento da inclusão na planilha, pela ordem numérica. Se o último foi 36, o próximo será 37, 38, 39...
É 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>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 ====
Nome do ente doador como ele se identifica.
 
==== <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
 
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.
 
==== <code>donor_date</code>: data de inclusão do doador ====
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;


==== scope_label: Área de atuação do doador ====
2 = Doador efetivo, uma vez feita alguma entrega, independentemente da qualidade;
É um código que identifica área de atuação do doador, que pode ser um município, estado ou província ou o país todo.


O código é composto pelos identificadores de duas letras de país e estado, e o nome do município sem acentos e preposições, separados por hifens, tudo sem espaço. Por exemplo, se a área de atuação do doador é o município de São José dos Pinhais, estado do Paraná, Brasil, seu código será BR-PR-SaoJosePinhais.
3 = Doador efetivo com pacotes de dados aprovados e publicados (''packs'').


O código de país e estado (ou província) é dado pela norma ISO 3166-2. 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]. Do Brasil é https://github.com/digital-guard/preserv-BR#readme; Colômbia https://github.com/digital-guard/preserv-CO#readme; Peru https://github.com/digital-guard/preserv-PE#readme, etc.
== Ver também ==


O código dos municípios do Brasil é dado por esta planilha: [ adicionar link ]
* [[dg:Guia de preenchimento da Planilha de Pacotes]]


; shortName: Nome curto ()
[[Categoria:Digital-guard]]
:
[[Categoria:Manuais]]
;vat_id (número de CNPJ):Pesquisar o CNPJ pela Internet.
;legalName (:Nome do doador;
;wikidata_id (código de identificador Wikidata):Nome do doador;
; url (endereço do site da entidade):endereço do site da entidade;
;donor_date:data de inclusão do doador;
;donor_status:status. [precisamos ver o que é]

Edição atual tal como às 04h12min de 22 de setembro de 2023

Disambig grey.svg 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.

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).

Ver também

Disponível em “https://wiki.addressforall.org/w/index.php?title=dg:Guia_de_preenchimento_da_Planilha_de_Doadores&oldid=2889”