Documentation Project

Owned by Bill Branan
Last updated: Jul 31, 2019 by ruth.k.tillman

This project was abandoned in favor of working on documentation for Hyrax, see: Documenting and Assessing Metadata in Hyrax

At the February 2017 meeting of the SMIG, a project was proposed to create and collect documentation related to metadata in Samvera. This documentation would be linked on the wiki as Google documents but eventually turned into wiki pages (Ruth's note: or we could skip the Google documents, but it may be useful as a draft space for the ideas to take shape). This page was created to record spaces for which documentation may exist or may be created and to allow people to add wishlist items under these spaces. 

Sample Documentation for Sufia Basic Metadata

https://github.com/no-reply/sufia-profile/blob/master/profile.md - do we expand from these base fields?

Possibly something along these lines (work still in progress): https://docs.google.com/document/d/1hjCnvp1HshiqTWaKeLlyjJ9a--7fstKUZ5YszcNeyNI/edit?usp=sharing

Shared Definitions

Documenting definitions for the kinds of things you might want to capture about a field. Open for people to contribute your version of a model of what the work type looks like at your institution:

Hyrax

Comparison done by Avalon to Hyrax/MODS & RDF https://docs.google.com/spreadsheets/d/1iKpx_jw5QY6-R5FH_2-HCcqdqIuJkDdP93xZyiY4tIU/edit#gid=0 

cmharlow proposal for Hyrax Metadata Specifications & Documentation:  https://gist.github.com/cmh2166/723bebaee52d9ba4eb68eebc9044843b

Proposals for documentation:

  • How-to: adding ontologies to Hyrax
  • How-to: decide which fields to index in Hyrax
    • note: this should include a basic overview of what indexing looks like in Hyrax.

Avalon

Fields defined in Batch Ingest Package Format

CurationConcerns

Sufia

Institutional Documentation

Julie Allinson - draft data models for thesis and journal article - https://drive.google.com/drive/u/0/folders/0B2Kouvo3lqGObHpqYlpXSE9iR3M

University of York have docs for models: Image, Thesis, Exam Paper and Dataset