Documentation
Definition¶
The descriptive account of the process of creating or curating information. This record accompanies the publication of such information. It provides contextualising information from a disciplinary point of view.
Definition source: Combatting Bias definition.
Stakes¶
part of: opacity
related to: transparency
Creating extensive documentation is crucial to ensure adequate contextualisation of your research and transparency around research practices. This creates accountability as well.
Where does it occur in the lifecycle?¶
All stages
Examples¶
- Hugging Face documentation: https://huggingface.co/docs
- Globalise Docs: https://docs.globalise.huygens.knaw.nl/mission/mission_researchthemes/
Good-better-best practices¶
| Good | Better | Best |
|---|---|---|
| Ensure that your dataset is accompanied by documentation that is suitable for your discipline and type of dataset. | Include versioning in all documentation to ensure transparency and encourage re-evaluation. | “Evaluate local descriptive practices and policies using the criteria: Which audiences does this description center? Which audiences does it exclude? For academic archives, this could look like making description more comprehensible for undergraduates, genealogists/family historians, and local community members. For archives collecting Spanish-language material, this could mean considering whether English-language finding aids are serving users. This could also look like minimizing archival jargon.”1 |
| “Do not use passive voice when describing oppressive relationships”2 | Make documentation an integral part of your research lifecycle. This ensures that the documentation is representative of all the work undertaken, and all the decisions made. |
Resources¶
- Data documentation:
- Data-envelopes for Cultural Heritage: https://aclanthology.org/2024.legal-1.9/
- Datasheets for Cultural Heritage: https://openhumanitiesdata.metajnl.com/articles/10.5334/johd.124
- AI Model Research Documentation Sheet (AIRDocS): https://zenodo.org/records/14550113
- The checklist for Collections as Data from the GlamLABS Community: https://www.emerald.com/insight/content/doi/10.1108/gkmc-06-2023-0195/full/html
- Datasheets at DRI: https://repository.dri.ie/catalog/8c980k93k#dri_download_modal_id
- Datasheets for Web Archive: https://blogs.bl.uk/webarchive/2024/11/datasheets-for-web-archives-toolkit-is-now-live.html
- Quality Measures for Datasets: https://datanutrition.org/labels/
-
Taken from Archives for Black Lives, Anti-Racist Description Resources (2019), p. 4. ↩
-
Taken from Archives for Black Lives, Anti-Racist Description Resources (2019), pp. 3-4. ↩