What is data documentation?
Any digital supplementary context files such as README.txt files, laboratory notebooks, data dictionaries, metadata schemas, standards, administrative materials, codebooks, user manuals, workflows, protocols, technical specifications or methodologies which explain the production, provenance, processing or interpretation of research data.
Minimum documentation required
Research data must include at least one documentation file which provides a brief description of the data. Although any one of the different types of documentation files can be uploaded onto SUNScholarData it is recommended that a README.txt file accompany the research data. A README file template is provided for use. For more information on README files please view the README file guideline.
Data can be organised in accordance with specific folder organisation techniques as well as file naming conventions. These techniques and conventions should be outlined in README.txt files.
Folder organisation techniques
Files are organised through the use of folders. These folders can be organised through several methods namely:
File naming conventions:
Indicate which information you will include in your file names. Good file names represent a combination of the following information:
What is metadata?
What is a metadata record?
Access settings will have to be assigned to research data. The research data published on SUNScholarData may have the following access settings:
Access settings will have to be assigned to research data. The research data published on SUNScholarData may have the following access settings:
A license (associated with the research data) should be selected in order to stipulate the manner in which others may use the data. Data and software files published on SUNScholarData will be made available under the terms of Creative Commons, Open Data Commons or standard Open Source licenses.
SUNScholarData's recommended citation format is based on the DataCite Metadata Schema. The citation format itself is influenced by the research data's item type (dataset, figure, media, software or data management plan). Below is the recommended citation format:
Author (PublicationYear): Title. SUNScholarData. (Dataset). SUNScholarData DOI
Author (PublicationYear): Title. SUNScholarData. (Figure). SUNScholarData DOI
Author (PublicationYear): Title. SUNScholarData. (Media). SUNScholarData DOI
Author (PublicationYear): Title. Version. SUNScholarData. (Software). SUNScholarData DOI
Author (PublicationYear): Title. SUNScholarData. (Data management plan). SUNScholarData DOI
Please note that in the case of software it may be desirable to include information from optional properties such as the Version.
Stellenbosch University Library and Information Service, Helpline Numbers: +27 21 808 4883, Postal Address: Private Bag X5036 Stellenbosch, 7599