Guideline 12
Documentation
Researchers document all information relevant to the production of a research result as clearly as is required by and is appropriate for the relevant subject area to allow the result to be reviewed and assessed. In general, this also includes documenting individual results that do not support the research hypothesis. The selection of results must be avoided. Where subject-specific recommendations exist for review and assessment, researchers create documentation in accordance with these guidelines. If the documentation does not satisfy these requirements, the constraints and the reasons for them are clearly explained. Documentation and research results must not be manipulated; they are protected as effectively as possible against manipulation.
Explanations:
An important basis for enabling replication is to make available the information necessary to understand the research (including the research data used or generated, the methodological, evaluation and analytical steps taken, and, if relevant, the development of the hypothesis), to ensure that citations are clear, and, as far as possible, to enable third parties to access this information. Where research software is being developed, the source code is documented.
Comments - Natural sciences (9)
Documentation of research results in experimental chemistry
23.04.2021 – When documenting research processes and results, the procedure must be mapped out as precisely as possible and also summarised for better verifiability.
Comment on: GL12 (Natural sciences)
Positive example of the utilisation of older data in the geosciences
03.12.2020 – Example from Saxony
Comment on: GL9 (Natural sciences) , GL10 (Natural sciences) , GL12 (Natural sciences) , GL13 (Natural sciences) , GL17 (Natural sciences)
Software development and handling research data in mathematics
03.12.2020 – Appropriate accessibility is important in terms of the verifiability of research work in mathematics where self-developed software and data are key factors.
Comment on: GL7 (Natural sciences) , GL12 (Natural sciences) , GL13 (Natural sciences) , GL14 (Natural sciences) , GL17 (Natural sciences)
Electronic laboratory journal and repository in chemistry
03.12.2020 – An electronic laboratory journal in conjunction with a repository are described as an example in the field of chemistry.
Comment on: GL7 (Natural sciences) , GL12 (Natural sciences) , GL13 (Natural sciences) , GL17 (Natural sciences)
Technical systems and metadata
03.12.2020 – Technical systems, along with their hardware and software, are usually made up of a mixture of commercial and self-created components. Ideally, the design phase should already take care that metadata is generated as automated and standardised as possible.
Comment on: GL12 (Engineering/engineering sciences) , GL12 (Natural sciences)
Laboratory journals and field books in the geosciences
03.12.2020 – Keeping a laboratory journal is also recommended in the geosciences.
Comment on: GL7 (Natural sciences) , GL12 (Natural sciences)
Documentation concept
03.12.2020 – Even in the planning phase of a research project, it is important to consider conceptual questions regarding data management as well as the documentation of project progression, methods and results.
Comment on: GL12 (Engineering/engineering sciences) , GL12 (Natural sciences)
Use of standards in the geosciences
03.12.2020 – It is always preferable to use standards that have been developed in the relevant subject areas.
Comment on: GL7 (Natural sciences) , GL11 (Natural sciences) , GL12 (Natural sciences)
Maintaining storage capacity in the geosciences
03.12.2020 – Long-term storage of research data
Comment on: GL7 (Natural sciences) , GL11 (Natural sciences) , GL12 (Natural sciences) , GL13 (Natural sciences) , GL15 (Natural sciences) , GL17 (Natural sciences)