Para documentar a fonte de um conjunto de dados no Mac, crie um README em texto simples junto aos dados e registre o provedor, a página original ou identificador, a data de download, a versão, a licença e quaisquer alterações feitas. Mantenha essa anotação com os arquivos do projeto para que a fonte possa ser encontrada novamente, mesmo que uma etiqueta do Finder, um favorito ou o histórico de downloads sejam perdidos. Este guia destina-se a usuários de Mac trabalhando em uma pasta de projeto local.

Crie uma anotação de fonte junto ao conjunto de dados

No Finder, abra a pasta do projeto e escolha Arquivo > Nova Pasta (ou pressione Shift-Command-N) se precisar de uma pasta para o arquivo original e sua documentação. Dê a ela um nome claro, como data-source, ou salve a anotação na pasta que já contém o conjunto de dados. A Apple documenta esse comando de pastas do Finder; manter os metadados próximos aos dados segue as diretrizes governamentais para o registro de informações de conjuntos de dados. Organize seus arquivos no Finder do Mac, Record information about data sets you share with others

Abra o Editor de Texto a partir de Aplicativos ou do Spotlight. Escolha Formatar > Converter para Texto Simples e, em seguida, crie um novo documento. O texto simples é uma escolha prática porque pode ser aberto sem a necessidade do mesmo aplicativo de processamento de texto e é fácil de ler junto ao conjunto de dados; o Cornell Data Services recomenda texto simples para arquivos README de dados. Salve-o na mesma pasta do conjunto de dados como README.txt ou README.md. Se a caixa de diálogo de salvamento do Editor de Texto sugerir uma extensão de texto formatado (rich text), verifique o nome do arquivo e o formato antes de salvar; os termos dos menus e as caixas de diálogo podem variar de acordo com a versão do macOS. Writing READMEs for Research Data

Registre detalhes suficientes para identificar a fonte exata

Use um registro compacto como o apresentado a seguir, substituindo cada campo pelas informações que puder verificar. Deixe o campo marcado como “desconhecido” se não puder confirmá-lo; não tente adivinhar.

  • Título do conjunto de dados e nome do arquivo:
  • Provedor original ou criador:
  • URL da página de origem ou identificador persistente:
  • Versão, edição ou data de publicação:
  • Data de obtenção (AAAA-MM-DD):
  • Licença ou termos de reutilização, conforme declarado pelo provedor:
  • Cobertura ou conteúdo relevante para este projeto:
  • Alterações feitas na cópia baixada:
  • Arquivos relacionados ou documentação:

A URL da página de origem deve apontar para a página do conjunto de dados do provedor, quando disponível, e não apenas para um link de download temporário. Adicione um identificador como um DOI, caso o provedor forneça um. Os padrões de catálogos de conjuntos de dados distinguem a página de destino (landing page), o publicador, a licença, a versão e a proveniência do conjunto de dados; registrar esses elementos separadamente facilita identificar a origem de uma cópia e qual versão ela representa. Data standards: Dataset

Registre a data em que você baixou ou recebeu o arquivo, não como se fosse a data de criação do conjunto de dados. Se puder verificar a data de lançamento ou atualização informada pelo provedor, identifique-a separadamente. Use o título real utilizado pelo provedor e escreva o nome da organização por extenso, em vez de depender de uma abreviação ambígua. A orientação do GOV.UK recomenda identificar quem criou o conjunto de dados, quando ele foi criado e um identificador exclusivo, além de aconselhar o uso de “unknown” (desconhecido) quando a informação não estiver disponível. Record information about data sets you share with others

Descreva o que aconteceu após o download

Um registro de fonte deve distinguir os dados originais do provedor da versão utilizada no seu projeto. Indique se você renomeou arquivos, filtrou linhas, combinou fontes, converteu formatos ou corrigiu valores. Se os dados não tiverem sofrido alterações, mencione isso apenas se tiver certeza. Para um arquivo derivado, identifique o nome do arquivo de entrada e resuma a operação; inclua um link para um script ou uma anotação de análise caso contenha as etapas reproduzíveis. As diretrizes de documentação de dados da Sandia recomendam especificamente nomear a fonte original para dados derivados e listar as etapas de processamento. Data Documentation – FAIR(ER) Data Sharing

Por exemplo, escreva “Filtrado para linhas com datas de 2022 a 2024; salvo como sales_2022_2024.csv” apenas quando isso descrever o seu trabalho com precisão. Não substitua o arquivo original silenciosamente: mantenha uma cópia intocada sempre que possível e atribua nomes distintos aos arquivos gerados por transformações. Se a página do provedor listar uma licença ou restrições de uso, registre o texto informado ou forneça um link para ele; a anotação ajuda a localizar os termos, mas não substitui a verificação se o uso planejado é permitido.

Use etiquetas do Finder apenas como atalho

Uma etiqueta do Finder pode ajudar você a localizar o conjunto de dados ou o README mais tarde. Selecione o item no Finder, escolha Arquivo > Etiquetas ou clique com a tecla Control pressionada e escolha uma etiqueta. A Apple afirma que as etiquetas podem ser usadas para localizar itens etiquetados a partir da barra lateral do Finder ou pela busca; as etiquetas são marcadores para encontrar arquivos, e não um substituto para a documentação do provedor, da versão e das alterações no README. Use etiquetas para organizar arquivos no Mac

Antes de considerar a fonte documentada, abra o README a partir da pasta do projeto e verifique se o nome do arquivo corresponde ao arquivo que você utilizou, se a URL ou identificador é específico o suficiente para recuperar a fonte e se cada data tem um significado claro. Se não for possível identificar a versão exata, registre essa limitação na anotação. Um registro curto e preciso é mais útil do que preencher todos os campos com suposições.

Fontes