8. What would someone unfamiliar
with your data need in order to find,
evaluate, understand, and reuse
them?
9. Documentation
• How?
– Take good notes
• Concise and legible
• Record more, not less
• Understandable to someone “skilled in the art”
10. Documentation
• How?
– Methods
• Protocols
• Code
• Survey
• Codebook
• Data dictionary
• Anything that lets someone reproduce your results
11. Documentation
• How?
– Templates
• Add structure to notes
• Decide on a list of information before you collect data
– Make sure you record all necessary details
– Takes a few minutes upfront, easy to use later
• Print and post in prominent place or use as worksheet
12. Example
• I need to collect:
– Date
– Experiment
– Scan number
– Powers
– Wavelengths
– Concentration (or sample weight)
– Calibration factors, like timing and beam size
13. Documentation
• How?
– README.txt
• For digital information, address the questions
– “What the heck am I looking at?”
– “Where do I find X?”
• Use for project description in main folder
• Use to document conventions
• Use where ever you need extra clarity
14. Example
• Project-wide README.txt
– Basic project information
• Title
• Contributors
• Grant info
• etc.
– Contact information for at least one person
– All locations where data live, including backups
15. Example
“Talk_v1: rough outline of talk
Talk_v2: draft of talk
Talk_v3: updated 2014-01-15 after feedback”
“ ‘Data’ folder contains all raw data files by date
‘Analysis’ has analyzed data and plots
‘Paper’ has drafts of article on this work”
16. Documentation
• How?
– Metadata schemas
• http://www.dcc.ac.uk/resources/metadata-standards
– Highly structured documentation
• If you have a lot of documentation to search and mine
• If you need to share your data
17. Example
• Contributor
– Jane Collaborator
• Creator
– Kristin Briney
• Date
– 2013 Apr 15
• Description
– A microscopy image of
cancerous breast tissues
under 20x zoom. This image is
my control, so it has only the
standard staining describe on
2013 Feb 2 in my notebook.
• Format
– JPEG
• Identifier
– IMG00057.jpg
• Relation
– Same sample as images
IMG00056.jpg and
IMG00055.jpg
• Subject
– Breast cancer
• Title
– Cancerous breast tissue
control