Guideline 12
Documentation
Researchers document all information relevant to the production of a re- search 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, re- searchers 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 re- search results must not be manipulated; they are protected as effectively as possible against manipulation.
Explanation
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
- Documentation concept
-
Documentation of results that do not support a hypothesis
The non-confirmation of a hypothesis is also a scientific accomplishment that contributes to gaining knowledge.
-
Handling of research data
-
Research software documentation
When the development of research results shall be fully documented, this more often includes the research software used.
-
Scope and completeness of documentation
It is important to distinguish between documentation within a research institution and published documentation.
-
Quality standards in connection with rapid publication
Rapid publication of research data and findings by no means allows any compromise to be made in terms of accepted quality standards in the given field.
-
Reproducibility of research results in medicine and biomedicine
-
Further links on the subject of documentation
-
Documentation in the life sciences
-
Documentation of research results in experimental chemistry
When documenting research processes and results, the procedure must be mapped out as precisely as possible and also summarised for better verifiability.
-
Electronic laboratory journal and repository in chemistry
The possibilities of an electronic laboratory journals linked to a repository in the context of chemistry are illustrated as examples.
-
Handling research data in the humanities and social sciences
Research data in humanities and social science projects are as diverse as the wide range of subjects and methods and form an integral part of the research results. A conscious approach to the documentation, maintenance, archiving and provision of data for later review and possible re-use is mandatory for all projects.
-
Laboratory journals and field books in the geosciences
Keeping a laboratory journal is recommended in the field of experimental geosciences
-
Maintaining storage capacity in the geosciences
Long-term storage of research data
-
Reusable and open methods and protocols in the life sciences
Recommendations for detailed recording of research methods
-
Software development and handling research data in mathematics
Appropriate accessibility is important in terms of the verifiability of research work in mathematics where self-developed software and data are key factors.
-
Use of standards in the geosciences
It is always preferable to use standards that have been developed in the relevant subject areas.
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.