Guia de documentação de dados de investigação

Objetivo: Este guia fornece instruções detalhadas aos autores sobre como documentar corretamente os dados de investigação, facilitando a sua compreensão, utilização e reutilização pela comunidade científica e pelo público em geral.

Âmbito de aplicação: Aplica-se a todos os dados de investigação, incluindo dados quantitativos e qualitativos, conjuntos de dados grandes e pequenos, e materiais relacionados, tais como códigos de software e protocolos, submetidos juntamente com manuscritos em PpA.

Princípios básicos da documentação: 
1. Clareza: A documentação deve ser clara e fácil de compreender.
2. Integralidade: Incluir toda a informação necessária para compreender, avaliar e utilizar os dados.
3. Acessibilidade: Garantir que a documentação seja facilmente acessível juntamente com o conjunto de dados.

Elementos essenciais da documentação

Metadados descritivos

- Título do conjunto de dados: Claro e descritivo, reflectindo o conteúdo do conjunto de dados.
- Autor(es): Nomes completos e instituições das pessoas que geraram os dados.
- Data de criação: Quando os dados foram gerados ou recolhidos.
- Versão: Se aplicável, a versão do conjunto de dados.
- Localização: Repositório onde os dados estão alojados e o seu identificador persistente (por exemplo, DOI).

Contexto dos dados

- Descrição geral: Uma explicação do que são os dados e para que investigação foram gerados.
- Palavras-chave: Termos que facilitam a pesquisa e a recuperação do conjunto de dados.
- Cobertura temporal e geográfica: O período e a localização geográfica dos dados.

Metodologia

- Recolha e processamento de dados: Descrever a forma como os dados foram recolhidos, processados e analisados.
- Padrões e calibrações: Quaisquer normas utilizadas ou calibrações efectuadas.
Instrumentação e software: Pormenores de qualquer equipamento ou software especializado utilizado.

Estrutura e formato dos dados

- Formato do ficheiro: Especificar o formato dos dados e as razões da sua escolha.
- Estrutura dos dados: Descrever a organização dos dados, incluindo a descrição das variáveis, códigos e unidades de medida.

Acesso e utilização

- Licença de utilização: Pormenores sobre a forma como os dados podem ser utilizados, incluindo eventuais restrições.
- Guia de acesso: Como aceder aos dados e a qualquer software necessário para visualização ou análise.

Apoio e contacto

- Contacto de apoio: Informações de contacto para questões ou esclarecimentos sobre os dados.

Melhores práticas

- Utilizar normas de metadados reconhecidas para facilitar a interoperabilidade.
- Incluir exemplos de como citar e reutilizar os dados.
- Garantir a privacidade e a ética, especialmente no caso de dados sensíveis.

Conclusão: A documentação correta dos dados é fundamental para a transparência, a replicabilidade e o avanço do conhecimento científico. A [Nome da revista] incentiva os autores a seguir estas diretrizes para maximizar o impacto e a acessibilidade da sua investigação.