Um ficheiro ReadMe inclui informação detalhada do seu conjunto de dados, para que outros investigadores o possam interpretar, compreender e, assim, reutilizar os seus dados e/ou replicar a sua experiência. Aqui inclui-se também informação sobre como o conjunto de dados foi criado, quão completo é, e que tipo de restrições tem. No DataRepositóriUM, este tipo de documentação pode ser fornecido de duas maneiras:
- nos campos de descrição (metadados), e
- num ficheiro ReadMe, em separado e que pode carregar juntamente com os seus ficheiros de dados.
O ficheiro ReadMe deve conter, no mínimo, a seguinte informação:
- Projeto/Dissertação/tese (título)
- Projeto/Financiamento (nome/acrónimo/ID financiamento)
- Autor (nome)
- Contacto (email)
- Descrição do dataset (descrição das etapas e método de recolha, fontes dos dados, processamento, análise e visualização dos dados; instrumentos utilizados, software, versões dos mesmos; descrever os ficheiros [ficheiro a ficheiro - pode ser feito diretamente no DatarepositóriUM]; identificar dados reutilizados (licenças, termos de uso, PID, etc.)
- Termos de acesso e uso (atribuição de licença e em que condições pode ser usado)
- O ficheiro ReadMe deve ser produzido em formato de texto simples com codificação de caracteres Unicode UTF-8 (.txt). Se precisar de ilustrar ou formatar a sua descrição, pode guardar o seu ficheiro ReadMe como PDF (veja a secção do Guia do DatarepositóriUM sobre formatos de ficheiros aqui).
Nome do ficheiro ReadMe: 00_ReadMe
- Poderá nomear este ficheiro adicionando "00_" em frente ao nome do ficheiro ReadMe (por exemplo "00_ReadMe.txt"), fazendo com que este apareça na parte superior da vista geral do seu conjunto de dados.