{"id":190,"date":"2025-11-27T12:43:59","date_gmt":"2025-11-27T17:43:59","guid":{"rendered":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/?post_type=chapter&#038;p=190"},"modified":"2026-03-01T21:22:32","modified_gmt":"2026-03-02T02:22:32","slug":"why-document-your-data","status":"publish","type":"chapter","link":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/chapter\/why-document-your-data\/","title":{"raw":"Why document your data?","rendered":"Why document your data?"},"content":{"raw":"<h4><a href=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/chapter\/metadata\/\">Previous Lesson<\/a><\/h4>\r\n<h4><img class=\"wp-image-740 aligncenter\" src=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14-300x201.jpg\" alt=\"\" width=\"1136\" height=\"761\" \/><\/h4>\r\n<h4>Lesson 3 of 17<\/h4>\r\n<h3>There are advantages to having clear and concise data documentation, for both you and any research team members you interact with, and also for any future data sharing.<\/h3>\r\n<h2><strong>Some of those advantages include:<\/strong><\/h2>\r\n<span style=\"color: #0000ff\"><strong>Easier to find and organize data<\/strong><\/span>\r\n\r\nResearch projects can be complex and evolve over time. Describing data and documenting practices makes it easier to find and organize your data and to return to it later.\r\n\r\n&nbsp;\r\n\r\n<span style=\"color: #0000ff\"><strong>Useful reference material<\/strong><\/span>\r\n\r\nDocumentation can serve as a reference for team members to maintain consistency in how data is handled, files named, and data storage organized.\r\n\r\nDocumentation also makes it easier to train new team members on a project or to explain processes to a supervisor or colleague.\r\n\r\n&nbsp;\r\n\r\n<span style=\"color: #0000ff\"><strong>Documentation makes data more reusable and shareable<\/strong><\/span>\r\n\r\nWell-documented data is easier for you to re-use within either a lab or project, or in similar future projects. It also enables broader sharing, when such sharing is appropriate for your project. Good data documentation allows someone else to understand your data set and how it was created. If you want to deposit your data in a repository and\/or make it shareable in another manner, good documentation facilitates that process by making it possible for others to understand and re-use your data set. If you know where you want to deposit your data, you can document it in a way that facilitates that deposit (see <a href=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/part\/module-5-data-deposit\/\">Module 5<\/a>).\r\n\r\nSome repositories may recommend particular documentation, for example:\r\n<ul>\r\n \t<li>A readme file that describes the data set<\/li>\r\n \t<li>A copy of blank consent forms to accompany human participant data.<\/li>\r\n \t<li style=\"list-style-type: none\"><\/li>\r\n<\/ul>\r\n&nbsp;\r\n\r\n<span style=\"color: #0000ff\"><strong>Documentation supports transparency and reproducibility of research<\/strong><\/span>\r\n\r\nDocumentation supports transparency and reproducibility of research. When data is described and documented, you can also use that documentation to discuss and support decisions made throughout a project.\r\n<h4><a href=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/chapter\/video-documenting-data-2\/\">Next Lesson<\/a><\/h4>","rendered":"<h4><a href=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/chapter\/metadata\/\">Previous Lesson<\/a><\/h4>\n<h4><img loading=\"lazy\" decoding=\"async\" class=\"wp-image-740 aligncenter\" src=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14-300x201.jpg\" alt=\"\" width=\"1136\" height=\"761\" srcset=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14-300x201.jpg 300w, https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14-1024x685.jpg 1024w, https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14-768x514.jpg 768w, https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14-65x43.jpg 65w, https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14-225x150.jpg 225w, https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14-350x234.jpg 350w, https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-content\/uploads\/sites\/2528\/2025\/11\/14.jpg 1352w\" sizes=\"auto, (max-width: 1136px) 100vw, 1136px\" \/><\/h4>\n<h4>Lesson 3 of 17<\/h4>\n<h3>There are advantages to having clear and concise data documentation, for both you and any research team members you interact with, and also for any future data sharing.<\/h3>\n<h2><strong>Some of those advantages include:<\/strong><\/h2>\n<p><span style=\"color: #0000ff\"><strong>Easier to find and organize data<\/strong><\/span><\/p>\n<p>Research projects can be complex and evolve over time. Describing data and documenting practices makes it easier to find and organize your data and to return to it later.<\/p>\n<p>&nbsp;<\/p>\n<p><span style=\"color: #0000ff\"><strong>Useful reference material<\/strong><\/span><\/p>\n<p>Documentation can serve as a reference for team members to maintain consistency in how data is handled, files named, and data storage organized.<\/p>\n<p>Documentation also makes it easier to train new team members on a project or to explain processes to a supervisor or colleague.<\/p>\n<p>&nbsp;<\/p>\n<p><span style=\"color: #0000ff\"><strong>Documentation makes data more reusable and shareable<\/strong><\/span><\/p>\n<p>Well-documented data is easier for you to re-use within either a lab or project, or in similar future projects. It also enables broader sharing, when such sharing is appropriate for your project. Good data documentation allows someone else to understand your data set and how it was created. If you want to deposit your data in a repository and\/or make it shareable in another manner, good documentation facilitates that process by making it possible for others to understand and re-use your data set. If you know where you want to deposit your data, you can document it in a way that facilitates that deposit (see <a href=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/part\/module-5-data-deposit\/\">Module 5<\/a>).<\/p>\n<p>Some repositories may recommend particular documentation, for example:<\/p>\n<ul>\n<li>A readme file that describes the data set<\/li>\n<li>A copy of blank consent forms to accompany human participant data.<\/li>\n<li style=\"list-style-type: none\"><\/li>\n<\/ul>\n<p>&nbsp;<\/p>\n<p><span style=\"color: #0000ff\"><strong>Documentation supports transparency and reproducibility of research<\/strong><\/span><\/p>\n<p>Documentation supports transparency and reproducibility of research. When data is described and documented, you can also use that documentation to discuss and support decisions made throughout a project.<\/p>\n<h4><a href=\"https:\/\/pressbooks.bccampus.ca\/rdmoer\/chapter\/video-documenting-data-2\/\">Next Lesson<\/a><\/h4>\n","protected":false},"author":2543,"menu_order":3,"template":"","meta":{"pb_show_title":"on","pb_short_title":"","pb_subtitle":"","pb_authors":[],"pb_section_license":""},"chapter-type":[],"contributor":[],"license":[],"class_list":["post-190","chapter","type-chapter","status-publish","hentry"],"part":184,"_links":{"self":[{"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/pressbooks\/v2\/chapters\/190","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/pressbooks\/v2\/chapters"}],"about":[{"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/wp\/v2\/types\/chapter"}],"author":[{"embeddable":true,"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/wp\/v2\/users\/2543"}],"version-history":[{"count":6,"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/pressbooks\/v2\/chapters\/190\/revisions"}],"predecessor-version":[{"id":741,"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/pressbooks\/v2\/chapters\/190\/revisions\/741"}],"part":[{"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/pressbooks\/v2\/parts\/184"}],"metadata":[{"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/pressbooks\/v2\/chapters\/190\/metadata\/"}],"wp:attachment":[{"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/wp\/v2\/media?parent=190"}],"wp:term":[{"taxonomy":"chapter-type","embeddable":true,"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/pressbooks\/v2\/chapter-type?post=190"},{"taxonomy":"contributor","embeddable":true,"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/wp\/v2\/contributor?post=190"},{"taxonomy":"license","embeddable":true,"href":"https:\/\/pressbooks.bccampus.ca\/rdmoer\/wp-json\/wp\/v2\/license?post=190"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}