Siirry sisältöön

LogoHelsingin yliopisto

Think Open

Digitaalisista tutkimuspalveluista ja avoimesta tieteestä / About digital research services and open science

What everyone should know about documentation – new guide pulls together the basics in 12 pages

Julkaistu 2018-12-102022-02-08 kirjoittanut Juuso P Ala-Kyyny

University of Helsinki’s DataSupport has published a guide for research data documentation. The guide introduces the basic elements of documentation and meets the needs of most researchers.

(Tämä artikkeli on saatavilla myös suomeksi.)

How can I get started on documenting my research data? Where can I find clear and detailed instructions for documentation?

The first version of the documentation guide was published in the end of November.

A new guide, Making a research project understandable – Guide for data documentation, answers the questions of researchers. It brings together the basics of data documentation in 12 pages. The guide has been written by information specialists Siiri Fuchs and Mari Elisa Kuusniemi from the University of Helsinki’s DataSupport.

”We have been lacking a guide that gathers together fundamental elements of data documentation. There’s a lot of information about this topic, but many guides only introduce parts of the subject. When reading researchers’ data management plans (DMP), I have noticed that only a few people understand what documentation means”, Fuchs says.

”This guide introduces the essential elements of documentation and for most people, the level presented here is sufficient. Data scientists and data managers are a different matter”, Kuusniemi says.

Documentation is a basic skill

The documentation guide is intended for anyone who does research. Documentation is a basic skill for researchers, and it should be taken in consideration both during and after a research project – the guide helps in both phases.

”The guide is useful for people who are interested in the quality and the efficiency of their research – and for those who want to open data. The guide can be used by anyone who wants to implement FAIR principles in the organization”, Kuusniemi says.

The FAIR data principles describe the goals for open data: open data requires that data are Findable, Accessible, Interoperable, and Reusable.

The guide can be utilized in many ways

Three points about documentation
    1. Planning proper documentation takes time at the beginning, but it saves time, money and nerves at the end.
    2. Documentation is a fundamental skill for a researcher. It is a skill that is always needed, and it should be mastered. Weirdly, documentation has not been taught and supported sufficiently considering its importance in research reliability (reducing errors), repeatability (verification of the results) and effectiveness.
    3. Documentation is not particularly difficult. However, attention should be paid to the quality of documentation, from start to finish. Most have done documentation partially, but there may be some missing pieces. The guide helps in identifying them.

Obviously, summarizing data documentation in 12 pages has called for pruning. For example, the theme of file formats was seen more related to storing and archiving than documentation. Although everything is not thoroughly explained in the guide, it gives tips on how to find further information.

For some researchers, the guide may seem self-evident. However, the summary of basic elements of data documentation (on page 4) can be helpful as a checklist in the research project.

”You can check what is missing. And if the research involves a number of people, the guide will keep everyone informed of basic documentation methods as well as help in introducing new people to the topic”, Kuusniemi says.

The guide is also suitable for training and teaching.

”The guide provides a basis for teaching, and it would be great, if documentation skills would be integrated to university’s bachelor’s or master’s level education”, Fuchs says.

The guide for data documentation will be updated on the basis of feedback. Feedback can be sent to DataSupport: datasupport@helsinki.fi.

KategoriatAvoin data / Open Data, Avoin tiede / Open Science, Tutkimusdatanhallinta / Research Data Management (RDM), Tutkimuspalvelut / Research Services Avainsanatdata documentation, Datasupport, DMP, documentation, FAIR, FAIR principles, guides, metadata, metadata formats

Think Open Blog

Tietoa blogista / About this blog >>

Toimitusneuvosto / Editorial Board >>

Kirjoittajaohjeet / Instructions for writers >>

Aiheet / Topics

  • Avoin data / Open Data (113)
  • Avoin julkaiseminen / Open Access (174)
  • Avoin opetus / Open Education (29)
  • Avoin tiede / Open Science (328)
  • Digihumanismi / Digital humanities (19)
  • Kansalaistiede / Citizen Science (3)
  • Tietosuoja / Data Protection (29)
  • Tietoturva / Information Security (21)
  • Tutkimuksen näkyvyys / Visibility of Research (61)
  • Tutkimuksen työkalut / Research Tools (64)
  • Tutkimusdatanhallinta / Research Data Management (RDM) (124)
  • Tutkimusinfrastruktuurit / Research Infrastructures (73)
  • Tutkimuspalvelut / Research Services (241)
  • Tutkimustunnisteet / Research Identifiers (16)

Kaikki blogitekstit julkaistaan CC-BY 4.0 -lisenssillä. Lisenssi ei koske kuvia. / All the blog texts are licensed under a CC-BY 4.0 license. The license does not apply to images.

Asiasanat / Tags

  • aineistonhallintasuunnitelma (23)
  • APC (38)
  • avoimet oppimateriaalit (20)
  • avoin data (33)
  • avoin julkaiseminen (99)
  • avoin opetus (25)
  • avoin oppiminen (20)
  • avoin tiede (118)
  • cOAlition S (23)
  • data (43)
  • data cleaning (25)
  • Data Cleaning Week (23)
  • datan avaaminen (23)
  • datanhallinta (58)
  • datasiivous (25)
  • Datasiivousviikko (21)
  • Data Support (41)
  • Datasupport (51)
  • Datatuki (47)
  • DMP (35)
  • Elsevier (21)
  • EU (26)
  • FAIR (31)
  • gold OA (30)
  • green OA (45)
  • HELDA (45)
  • Helda Open Books (30)
  • hybrid OA (22)
  • julkaisuarkistot (41)
  • kirjoittajamaksut (28)
  • metadata (29)
  • open access (148)
  • open science (59)
  • plan S (34)
  • RDM (58)
  • repositories (23)
  • research data (26)
  • research data management (51)
  • rinnakkaisjulkaiseminen (22)
  • rinnakkaistallennus (35)
  • self-archiving (20)
  • Suomen Akatemia (31)
  • tiedekustantajat (22)
  • tutkimusdata (34)
  • tutkimusdatanhallinta (44)

Arkisto / Archives

  • toukokuu 2023 (12)
  • huhtikuu 2023 (4)
  • maaliskuu 2023 (8)
  • helmikuu 2023 (6)
  • tammikuu 2023 (3)
  • joulukuu 2022 (6)
  • marraskuu 2022 (1)
  • lokakuu 2022 (6)
  • syyskuu 2022 (4)
  • elokuu 2022 (2)
  • toukokuu 2022 (6)
  • huhtikuu 2022 (4)
  • maaliskuu 2022 (10)
  • helmikuu 2022 (9)
  • tammikuu 2022 (2)
  • joulukuu 2021 (6)
  • marraskuu 2021 (10)
  • lokakuu 2021 (9)
  • syyskuu 2021 (4)
  • elokuu 2021 (3)
  • kesäkuu 2021 (1)
  • toukokuu 2021 (5)
  • huhtikuu 2021 (8)
  • maaliskuu 2021 (11)
  • helmikuu 2021 (8)
  • tammikuu 2021 (6)
  • joulukuu 2020 (4)
  • marraskuu 2020 (7)
  • lokakuu 2020 (12)
  • syyskuu 2020 (12)
  • elokuu 2020 (7)
  • kesäkuu 2020 (6)
  • toukokuu 2020 (10)
  • huhtikuu 2020 (5)
  • maaliskuu 2020 (7)
  • helmikuu 2020 (4)
  • tammikuu 2020 (6)
  • joulukuu 2019 (27)
  • marraskuu 2019 (9)
  • lokakuu 2019 (16)
  • syyskuu 2019 (9)
  • elokuu 2019 (8)
  • kesäkuu 2019 (3)
  • toukokuu 2019 (8)
  • huhtikuu 2019 (5)
  • maaliskuu 2019 (6)
  • helmikuu 2019 (4)
  • tammikuu 2019 (7)
  • joulukuu 2018 (5)
  • marraskuu 2018 (4)
  • lokakuu 2018 (9)
  • syyskuu 2018 (7)
  • elokuu 2018 (6)
  • heinäkuu 2018 (3)
  • kesäkuu 2018 (5)
  • toukokuu 2018 (5)

Meta

  • Kirjaudu sisään
  • Sisältösyöte
  • Kommenttisyöte
  • WordPress.org

Think Open blog

Tietoa blogista /
About this blog

Toimitusneuvoston jäsenet /
Members of the editorial board

Kirjoittajaohjeet /
Instructions for writers

Kirjaudu sisään / Log in

Palvelun tarjoaa WordPress