[Content Review] Instructor perspective

[SilkeGerlich]

This content review will be conducted through the eyes of a potential instructor. It focuses on the content that is directed specifically at instructors (anything only accessible in instructor view mode).

General review instructions

Where to start

• Browse the website that I have shared with you (Start here: site/docs/index.html) in Instructor View.
• Open the document's diff in the pull request #1 (from the list of documents provided below), that corresponds with the site you are currently reviewing, in Githubs WebIDE.

Minor Changes If you find a typo or grammar mistakes, feel free to directly change them in the individual documents provided below.

Major Changes If you find larger issues with the content (representation, structure, clarity), comment preferably at the respective place in the pull request. Or use this issue for overarching comments or feature requests

While reviewing the content please also keep an eye on:

• spelling / grammar
• hyperlinks (all links should be active and open a new tab in your browser.)
• general clarity / understandability
• site navigation

Through the eyes of an INSTRUCTOR :eyes:

Guiding questions

Keep these questions in the back of your mind, while reviewing the content

• Are the learner profiles (Learner view) clear and do they give you a good idea of the target group?
• Are the instructions clear and understandable? Do you lack further information?
• Is it easy to navigate the lesson and find the information you are looking for?
• Is the attached material complete, comprehensive and findable?
• Do you feel comfortable to hold this lesson based on the given information?

Focus points

• instructor notes (pink boxes)
• slide set and talking points
• schedule
• navigation

List of documents for review

look at these documents in depth:

1. Landing page: index.md
2. General Lesson Information: general-lesson-information.Rmd (metadata on top will be updated during the review :wink:)
3. Instructor Guide: instructor-guide.Rmd

instructor content in these document is duplicated from instructor-guide.Rmd. Scan these documents / sites for consistency:

1. Episode 1: getting-started.Rmd
2. Episode 2: data-metadata.Rmd
3. Episode 3: structure-schema.Rmd
4. Episode 4: enabling-technologies-standards.Rmd
5. Episode 5: web-locations-identifiers.Rmd

disregard these files as they are still under construction:

1. Acknowledgements: acknowledgements.Rmd
2. Meet the Creators: meet-the-creators.Rmd
3. Outlook - Linked Data: conclusion-outlook.Rmd will be included in lesson version 1.1

When you finish your review

• Head over to the pull request
• Check your tick box in the first comment
• Comment yourself, if you like :wink:

Good to know

If you have immediate questions or need a quick fix, use the review Mattermost channel or comment in this issue.

:heart: Thank you so much for your support in the reviewing process :heart:

[aazocar]

Guiding questions

• Are the learner profiles (Learner view) clear and do they give you a good idea of the target group?

1. Yes, learner profiles are great 👍🏽
2. In the learner view, you land in Summary and Setup, what is the Setup part referring to?

• Are the instructions clear and understandable? Do you lack further information?

1. In general I felt it was all clear. When we reached the last lecture about the web and so on, I wondered if it's clear to all learners. 🤔
2. In these two cases, Challenge: Metadata Standards and Guided Confrontation: Metadata in Scientific Publications. I did wonder if someone who has not seen it before would be able to get what to do. Maybe some warning that you should know some metadata standards in some scientific fields? Or maybe you can give some examples. In the publication case, I asked if the penguin poop will be suggested, if not, there should be at least some sort of warning that it should be a very short publication.

• Is it easy to navigate the lesson and find the information you are looking for?
• Is the attached material complete, comprehensive and findable?

1. In the Summary and Schedule section I completely missed the schedule 😁 It comes after the HMC logo and I thought this comes at the end.
2. Also, depending where you are, the pages on top change, for me it would be better if you could always have the General lesson information and the Instructor guide on top (most of the time they come under more...)

• Do you feel comfortable to hold this lesson based on the given information?

1. Is there a meaning to bold face in the lecture talking points. Sometimes it was important words (like HTTP or GET), sometimes it was the most important point of the slide. I guess one could streamline this, but it's not super important.

[aazocar]

I don't know if this is relevant but in JsonStepByStep.pdf, the example is using double comma quotation marks (the curly ones). If you copy paste this into a JSON formatter it complains that it is invalid, and you have to use the Fix JSON option, where it replaces the incorrect quotes. Would it be better to replace the quotations directly on the slides?

same in slides 5-7 of MetadataSchemas slides

[apirogov]

Yeah, in technical stuff you should use ' and ", everything else usually will be broken and not work. For prose and actual quotes, ideally use the special correct symbols.

[aazocar]

In the TODO: Before the lesson

send the link to the “Episode 1: Getting started” 2-3 days before the lesson starts.

Is it possible to send the link only to one episode? or would people get access to the full lesson?