Instructor Guide
Last updated on 2023-11-16 | Edit this page
To Do: Before the lesson
- send the link to the “Episode 1: Getting Started” 2-3 days before the lesson starts.
- prepare group handouts for the first day by including the challenges 2 and 3. You can find a Markdown template here: General Lesson Information - Group Challenges and Handouts
Lesson Schedule
Overview
| Episode | Description | |
|---|---|---|
| — | 1 |
Getting Started This episode is not part of the actual teaching content. It will be sent to the learners prior to the lesson. It contains one brief challenge that encourages the learners to engage with the example data object. The learners’ experience will be shared during the first Episode 0: Housekeeping session. |
Day 1
| Episode | Description | |
|---|---|---|
| 35 min | 0 |
Housekeeping The lesson starts with an introduction by the instructors, and usually the hosting organization, to the learners. The learners introduce themselves briefly and report on their first impressions of the example data object. Scope and schedule of the lesson are outlined. |
| 75 min | 2 |
Data and
Metadata The learners get an introduction to data and metadata in everyday life and research contexts. Descriptive, administrative, and structural metadata are distinguished. The learners conduct a guided online search (URLs are provided) and explore the metadata tagging in selected web pages. Good (enough) and worst practices of metadata annotation will be covered in the final talk of this module. The presentation is complemented by a live demonstration, collaboratively extracting metadata from scientific publications. |
| 100 min | 3 |
Structured
Metadata: From Markup to JSON This episode introduces the concept of semi-structured metadata in the context of machine accessibility and interoperability. After defining the term Markup, the learners will be confronted with XML and JSON as (meta)data exchange formats. In the challenges 2 & 3, the learners will apply the lecture content to the example data object by extracting metadata from an accompanying README file and annotating
the example data object using JSON. Challenges will be tackled in groups
of 4 - 6 learners. Group results are compared and discussed in a plenary
discussion. Ideally, the learners will experience light frustration
during result comparison, realizing, that structuring their metadata
will result in valid machine-interpretable data objects, yet lack
comparability and reusability. |
| 20 min | 0 |
Housekeeping Day 1 concludes with a brief recap on the topics of the first day. Feedback is gathered from the learners and eventually implemented in day 2. An outlook on the content of the second day is presented. |
| To Do: After Day 1 |
Day 2
| Episode | Description | |
|---|---|---|
| 15 min | 0 |
Housekeeping The learners get a brief recap of the contents of day 1 and an outlook on day 2. In the warm-up session, the learners actively apply their knowledge acquired on day 1 by completing a personal JSON object using a provided template. |
| 120 min | 4 |
Enabling
Technologies and Standards The episode starts with a short history of the World Wide Web from a scholarly perspective, highlighting the benefits of this technology for sharing information. Metadata schemas are introduced in depth by lectures and live coding. Learners practice writing a JSON Schema in a group challenge. Subsequently, the written schema is visualized in a web interface, illustrating a possible application. The concept of metadata standards is introduced and distinguished from metadata schemas. Some community-independent standards with wide adoption in the scientific context and beyond are investigated. In the following challenge, the learners are introduced to terminology registries, practice their navigation and get the opportunity to identify metadata terminologies relevant for their fields of research. |
| 60 min | 5 |
(Web)
Location and Identifiers This episode is an introduction to the concept and technology of Persistent Identifiers (PIDs) on the World Wide Web. The learners are familiarized with the technology of client-server communication on the web, learn to differentiate between URN, URL, URI, and PID, and get to know PID services commonly used in the scientific community. Further, the application of (Persistent) Identifiers in metadata records is discussed. |
| 45 min | 0 |
Lightning
Talk An invited speaker presents a real-world research example and demonstrates how applied metadata can shape research. |
| 15 min | 0 |
Housekeeping This module concludes the lesson. A summarizing overview of the past two days is given. The learners provide their feedback on the lesson. The instructors give feedback to the learners. |
| To Do: After the lesson |
Episode 0: Housekeeping
Episode Schedule
| Content type | Title | |
|---|---|---|
| 5 min | Lecture | Instructor introduction |
| 28 min | Group activity | Learner introduction |
| 2 min | Lecture | Lesson scope & structure |
Total time: 35 min
Teaching
methods: direct teaching, group activity, discussion
Learning types: acquisition, collaboration
REMEMBER
- The participants are aware of the tasks and contact information of the hosting organization.
- The learners get to know the teacher and the other participants. An open and collaborative working atmosphere is created.
Description:
The lesson starts with an
introduction by the instructors, and usually the hosting organization,
to the learners. The learners introduce themselves briefly and report on
their first impressions of the example data object. Scope and schedule
of the lesson are outlined.
Talking Points:
Episode 2: Data and Metadata
Episode Schedule
| Content type | Title | |
|---|---|---|
| 5 min | Lecture | What is data? |
| 5 min | Lecture | The example data object |
| 5 min | Lecture | What is metadata? |
| 5 min | Lecture | Descriptive, administrative, structural metadata |
| 15 min | Challenge | Real-world metadata |
| 10 min | Lecture | Metadata in the scientific context |
| 15 min | Guided confrontation | Metadata in scientific publications |
| 15 min | ☕ Break ☕ |
Total time: 75 min
Teaching
methods: direct teaching, guided confrontation
Learning types: acquisition, investigation,
discussion
UNDERSTAND
- The learners get familiar with the example data object.
- The learners recognize and describe examples of (meta)data.
- The learners name examples for best / worst practice situations in research (meta)data handling.
Description:
The learners get an introduction to
data and metadata in everyday life and research contexts. Descriptive,
administrative, and structural metadata are distinguished. The learners
conduct a guided online search (URLs are provided) and explore the
metadata tagging in selected web pages. Good (enough) and worst
practices of metadata annotation will be covered in the final talk of
this module. The presentation is complemented by a live demonstration,
collaboratively extracting metadata from scientific publications.
Talking Points:
Episode 3: Structured metadata: From Markup to JSON
Episode Schedule
| Content type | Title | |
|---|---|---|
| 5 min | Lecture | Introduction to information transfer |
| 15 min | Lecture | What is Markup, XML and JSON? |
| 7 min | Lecture | JSON step-by-step |
| 3 min | Lecture | Challenge Introduction |
| 15 min | Challenge | Identify metadata in README.txt |
| 20 min | Challenge | Write JSON metadata record |
| 15 min | ☕ Break ☕ | |
| 20 min | Discussion | Challenge reflection |
Total time: 100 min
Teaching
methods: direct teaching, guided confrontation, live
demonstration, group activity
Learning types:
acquisition, discussion, practice, production
UNDERSTAND
- The learners explain the importance of semi-structured metadata for machine readability.
- The learners understand, read, and write basic Markdown / HTML / XML / JSON.
Description:
This episode introduces the concept
of semi-structured metadata in the context of machine accessibility and
interoperability. After defining the term Markup, the
learners will be confronted with XML and JSON as (meta)data exchange
formats. In challenges 2 & 3, the learners will apply the lecture
content to the example data object by extracting metadata from an
accompanying README file and annotating the example data
object using JSON. Challenges will be tackled in groups of 5 - 7
learners. Group results are compared and discussed in a plenary
discussion. Ideally, the learners will experience light frustration
during result comparison, realizing, that structuring their metadata
will result in valid machine-interpretable data objects, yet lack
comparability and reusability.
Talking Points:
Episode 0: Housekeeping
Episode Schedule
| Content type | Title | |
|---|---|---|
| 5 min | Lecture | Refelction Day 1 |
| 10 min | Group activity | Feedback Day 1 |
| 4 min | Lecture | Outlook Day 2 |
| 1 min | Farewell |
Total time: 20 min
Teaching
methods: direct teaching, group activity, discussion
Learning types: acquisition, collaboration
REMEMBER
- The learners are familiar with online resources to deepen their knowledge on research (meta)data handling.
- The learners are aware of the content of day 2.
Description:
Day 1 concludes with a brief recap
of the topics of the first day. Feedback is gathered from the learners
and eventually implemented on day 2. An outlook on the content of the
second day is presented.
Talking Points:
To Do: After day 1
- prepare group handouts for the second day by adding challenges 4 and 5.
- review the feedback slides and implement the wishes of the learners in the content for the second day as much as possible. Some wishes might lie outside of the scope of the lesson. In this case, we recommend providing informative links for further reading (e.g. in the group handouts).
Episode 0: Housekeeping
Episode Schedule
| Content type | Title | |
|---|---|---|
| 5 min | Lecture | Welcome back |
| 10 min | Group activity | Learners’ Warm-up |
Total time: 15 min
Teaching
methods: direct teaching, group activity
Learning
types: acquisition, practice
REMEMBER
- The learners are warmed up and remember the content of the previous day.
Description:
The learners get a brief recap of
the contents of day 1 and an outlook on day 2. In the warm-up session,
the learners actively apply their knowledge acquired on day 1 by
completing a personal JSON template.
Talking Points:
Episode 4: Enabling technologies and Standards
Episode Schedule
| Content type | Title | |
|---|---|---|
| 10 min | Lecture | A brief history of the World Wide Web |
| 10 min | Lecture | Metadata schemas |
| 8 min | Guided confrontation | Live coding a JSON Schema |
| 2 min | Lecture | Challenge introduction |
| 20 min | Challenge | JSON Schema |
| 10 min | Challenge | Form input & validation with JSON Schema |
| 10 min | Discussion | Challenge reflection |
| 5 min | Lecture | Summary - Annotating the example data |
| 15 min | ☕ Break ☕ | |
| 4 min | Lecture | Metadata standards |
| 1 min | Lecture | Challenge introduction |
| 25 min | Challenge | Metadata standards |
Total time: 120 min
Teaching
methods: direct teaching, group activity
Learning
types: acquisition, practice, collaboration, production
REMEMBER
- The learners memorize the meaning of the World Wide Web as a product of and tool for the scientific community.
- The learners are familiar with online registries for metadata terminologies
- The learners contrast the terms “metadata schema” and “metadata standard.”
- The learners understand, read and write XML and JSON Schema.
- The learners navigate online terminology registries.
Description:
The episode starts with a short
history of the World Wide Web from a scholarly perspective, highlighting
the benefits of this technology for sharing information. Metadata
schemas are introduced in depth by lectures and live coding. Learners
practice writing a JSON Schema in a group challenge.
Subsequently, the written schema is visualized in a web interface,
illustrating a possible application. The concept of metadata
standards is introduced and distinguished from metadata schemas.
Some community-independent standards with wide adoption in the
scientific context and beyond are investigated. In the following
challenge, the learners are introduced to terminology
registries, practice their navigation and get the opportunity to
identify metadata terminologies relevant for their fields of
research.
Talking Points:
Episode 5: (Web) Location and Identifiers
Episode Schedule
| Content type | Title | |
|---|---|---|
| 2 min | Group activity | PID poll |
| 4 min | Lecture | The Web of Today |
| 14 min | Lecture | Identifiers and Web Locations |
| 2 min | Guided confrontation | Error 404 |
| 8 min | Lecture | Persistent Identifier |
| 5 min | Lecture | PIDs and Metadata |
| 5 min | Guided confrontation | DOI Record |
| 5 min | Lecture | Machine-Actionability and Interoperability |
| 15 min | ☕ Break ☕ |
Total time: 60 min
Teaching
methods: direct teaching, group activity
Learning
types: acquisition
REMEMBER
- The learners memorize the technology of resource retrieval and client-server communication on the Web.
- The learners are familiar with PIDs and can name examples relevant for research.
- The learners discover the usage of URLs and PIDs in metadata records.
- The learners explain the difference between URL, URN, URI and PID(s)
- The learners indicate the advantages of assigning Web publications with PIDs in the scientific context.
Description:
This episode is an introduction to
the concept and technology of persistent identifiers (PIDs) on
the World Wide Web. The learners are familiarized with the technology of
client-server communication on the web, learn to differentiate between
URN, URL, URI, and PID, and get to know PID services commonly used in
the scientific community. Further, the application of (persistent)
identifiers in metadata records is discussed.
Talking Points:
Episode 0: Lightning Talk
Episode Schedule
| Content type | Title | |
|---|---|---|
| 30 min | Lecture | Lightning Talk |
| 15 min | Group activity | Q&A with invited speaker |
Total time: 45 min
Teaching
methods: direct teaching, group activity
Learning
types: acquisition
REMEMBER
- The learners discover a real-world example of a research metadata topic.
- The learners feel motivated to improve their (meta)data handling.
Description:
An invited speaker presents a real
world research example and demonstrates how applied metadata can shape
research.
Talking Points:
Episode 0: Housekeeping
Episode Schedule
| Content type | Title | |
|---|---|---|
| 5 min | Lecture | Reflection |
| 5 min | Group activity | Feedback poll |
| 5 min | Feedback | Instructor feedback and farewell |
Total time: 15 min
Teaching
methods: direct teaching, group activity
Learning
types: acquisition, reflection
REMEMBER
- The learners reflect on the lesson and give their feedback.
- The learners voice thir wishes for future lessons.
Description:
This module concludes the lesson.
An summarizing overview of the past two days is given. The learners
provide their feedback on the lesson. The instructors give feedback to
the learners.
Talking Points:
To Do: After the lesson
- If you used shared documents during the lesson, restrict editing rights in these documents.
- Feel free to share the slides with the learners.
- Internally evaluate the event (all instructors and teaching supports). If you like, you can use our Internal Evaluation Form as a guideline.
And as we are already talking about feedback and evaluation, your lesson feedback and contributions are most welcome! You can get in touch via the channels provided in the General Lesson Information.