1 / 11

Explain it

Explain it. Why your Research deserves good documentation and metadata. 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 /.

brody
Download Presentation

Explain it

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Explain it Why your Research deserves good documentation and metadata

  2. 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/

  3. Make material understandable MAKE SURE YOU CAN UNDERSTAND IT LATER What’s obvious now might not be in a few months, years, decades… Image: http://www.flickr.com/photos/archer10/5692813531/

  4. 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/

  5. Make material reusable • Material may be re-used by someone in a different discipline • Provide context to minimise the risk of it being misunderstood or misused

  6. 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

  7. Make material findable • Comprehensive descriptive metadata allows relevant material to be discovered more easily • Related materials (eg other files) can be located

  8. What to include (I) • Who created it, when and why • Include: • Description of the item • Methodology • Units of measurement • References to related data ? www.texample.net M. Farinelli et al. (2012) PLoSONE 7(3): e34047 description n. A set of characteristics by which something can be recognised

  9. What to include (II) • Define jargon, acronyms and code CC Gavin Llewellyn http://www.flickr.com/photos/gavinjllewellyn/6826303487/ • Provide technicalinformation about the file • (may be generated automatically)

  10. 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

  11. Open Access Teaching Materials for Digital PreservationProduced 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.

More Related