Um ficheiro leia-me fornece informações sobre um arquivo de dados e destina-se a ajudar a garantir que os dados podem ser interpretados corretamente, por si mesmo em uma data posterior, ou por outros quando o compartilhamento ou a publicação de dados. Metadados baseados em padrões são geralmente preferíveis, mas quando não existe um padrão apropriado, para uso interno, escrever metadados estilo “readme” é uma estratégia apropriada.

deseja um modelo?, Baixe um e adapte-o para os seus próprios dados!

  • as Melhores práticas
  • conteúdo Recomendado
    • informações Gerais
    • Dados de arquivo e visão geral
    • o acesso e Partilha de informação
    • informações Metodológicas
    • Dados específicos de informação
  • informações Relacionadas

Melhores práticas

Criar ficheiros leia-me para a lógica de “clusters” de dados. Em muitos casos, será apropriado criar um documento para um conjunto de dados que tenha múltiplos, relacionados, formatados de forma semelhante, ou arquivos que são logicamente agrupados para uso (ex., uma coleção de scripts Matlab). Às vezes pode fazer sentido criar um readme para um único arquivo de dados.

nomeie o readme para que seja facilmente associado com o(s) ficheiro (s) de dados que descreve.

escreva o seu documento readme como um ficheiro de texto simples, evitando formatos proprietários como o MS Word sempre que possível. Formatar o documento readme para que seja fácil de entender (por exemplo, separar informações importantes com linhas em branco, em vez de ter todas as informações em um parágrafo longo).

Formate multiple readme files identically., Apresentar a informação pela mesma ordem, utilizando a mesma terminologia.

Use formatos de data padronizados. Formato sugerido: W3C / ISO 8601 date standard, que especifica a notação Internacional de AAAA-MM-DD ou aaaa-MM-DDThh:mm:ss.

siga as convenções científicas para a sua disciplina de nomes e palavras-chave taxonômicos, geoespaciais e geológicos. Sempre que possível, use Termos de taxonomias e vocabulários padronizados, alguns dos quais estão listados abaixo.

o conteúdo recomendado

o conteúdo mínimo recomendado para a reutilização dos dados está a negrito.,de

  • as Pessoas envolvidas com a coleta de amostras, processamento, análise e/ou apresentação

    • de Dados-informações específicas

    *Repita esta seção, conforme necessário, para cada conjunto de dados (ou arquivo, conforme apropriado)*

    1. Contagem do número de variáveis e o número de casos ou de linhas
    2. lista de Variáveis, incluindo nomes completos e definições (soletrar palavras abreviadas) dos títulos de coluna para a tabela de dados
    3. Unidades de medida
    4. Definições de códigos ou símbolos usados para gravar dados em falta
    5. formatos Especializados ou outras abreviaturas usado

    Quer um modelo?, Baixe um e adapte-o para os seus próprios dados!as orientações anteriores foram adaptadas a partir de várias fontes, incluindo: Melhores Práticas para a criação de publicações de dados reutilizáveis. Driade. 2019. https://datadryad.org/stash/best_practices

    formatos de ficheiro. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/file-formats

    Introdução aos direitos de Propriedade Intelectual na gestão de dados. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/intellectual-property

    metadados e dados descritivos. Cornell Research Data Management Service Group. http://data.research.cornell.edu/content/writing-metadata