EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.
-
Upload
keila-alcott -
Category
Documents
-
view
217 -
download
0
Transcript of EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.
![Page 1: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/1.jpg)
EXPLAIN ITWHY YOUR RESEARCH DESERVES
GOOD DOCUMENTATION AND METADATA
![Page 2: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/2.jpg)
Why create documentation?
• Creating documentation can seem like a waste of time
• Good documentation will include a lot of information that might seem obvious
www.flickr.com/photos/smutjespickles/2434418686/
![Page 3: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/3.jpg)
Make material understandable
What’s obvious now might not be in a few months, years, decades…
Image: http://www.flickr.com/photos/archer10/5692813531/
MAKE SURE YOU CAN
UNDERSTAND IT LATER
![Page 4: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/4.jpg)
Make material verifiable
• Detailing your methods helps people understand what you did
• Explaining your algorithms, search methods etc makes your work reproducible
• Conclusions can be verified
Image by woodleywonderworks on flickr: http://www.flickr.com/photos/wwworks/4588700881/
![Page 5: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/5.jpg)
• Material may be re-used by someone in a different discipline
• Provide context to minimise the risk of it being misunderstood or misused
Make material reusable
![Page 6: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/6.jpg)
Documentation & Metadata
• Metadata are:– Machine readable– Written according to standards
“I guess it makes sense for a robot to read an e-book [401]” by brianjmatis on flickr
![Page 7: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/7.jpg)
Make material findable
• Comprehensive descriptive metadata allows relevant material to be discovered more easily
• Related materials (eg other files) can be located
![Page 8: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/8.jpg)
www.texample.net
• Who created it, when and why
• Include:• Description of the item• Methodology• Units of measurement• References to related data
What to include (I)
?
description n.A set of characteristics by which something can be recognised
M. F
arinelli et al. (2012) P
LoS O
NE
7(3): e34047
![Page 9: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/9.jpg)
What to include (II)
CC Gavin Llewellynhttp://www.flickr.com/
photos/gavinjllewellyn/6826303487/
• Provide technical information about the file (may be generated automatically)
• Define jargon, acronyms and code
![Page 10: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/10.jpg)
Explain it
• Create documentation to make data: – Understandable– Findable (and searchable)– Verifiable– Re-usable
• Explain:– Who created it, when and why– Methodologies and analysis techniques– Jargon, acronyms and code
![Page 11: EXPLAIN IT WHY YOUR RESEARCH DESERVES GOOD DOCUMENTATION AND METADATA.](https://reader035.fdocuments.in/reader035/viewer/2022081515/551bfc48550346a84f8b49b9/html5/thumbnails/11.jpg)
Open Access Teaching Materials for Digital Preservation
Produced by Anna Collins (2012) for the JISC-funded PrePARe project
This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 2.0 UK: England & Wales License.