data-lessons / librarycarpentry

Materials for Library Carpentry development
22 stars 8 forks source link

Instructor Guides for LC lessons #27

Closed weaverbel closed 6 years ago

weaverbel commented 7 years ago

I would like to see instructor guides developed for all Library Carpentry lessons. This could be a good sprint project. Librarians will probably like to have some guidance on how to teach what for many will be new material. Not sure what instructor guides should consist of? Then see some of the guides for Software Carpentry lessons, e.g. shell - http://swcarpentry.github.io/shell-novice/guide/, python - http://swcarpentry.github.io/python-novice-inflammation/guide/.

Guides like this help with context setting, things to remember to explain, and other useful info.

tracykteal commented 7 years ago

These are definitely great and would be a good sprint project. There's a nice template for instructor guides that @k8hertweck put together in the SWC lesson-example repo https://github.com/swcarpentry/lesson-example/blob/gh-pages/_extras/guide.md

pitviper6 commented 7 years ago

Great idea! I'd love to work on those!

On Wed, May 3, 2017 at 2:18 PM, Tracy Teal notifications@github.com wrote:

These are definitely great and would be a good sprint project. There's a nice template for instructor guides that @k8hertweck https://github.com/k8hertweck put together in the SWC lesson-example repo https://github.com/swcarpentry/lesson-example/ blob/gh-pages/_extras/guide.md

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/data-lessons/librarycarpentry/issues/27#issuecomment-299038413, or mute the thread https://github.com/notifications/unsubscribe-auth/APGpfr4YIfIA4-L9ZpL-ABT7A_5pjGvFks5r2O8agaJpZM4NP9ic .

k8hertweck commented 7 years ago

Thanks for spreading word of the template, @tracykteal. I'd be really excited to see Library Carpentry get some examples of these notes put together so we can see how they work with lessons (and then maybe find some folks to rework the old notes from SWC and SC into the new template)

tracykteal commented 7 years ago

We used it for the Data Carpentry Ecology spreadsheet lesson, if you're looking for an example. It worked well!

http://www.datacarpentry.org/spreadsheet-ecology-lesson/guide/

drjwbaker commented 7 years ago

Okay. This does look like a sprint task. But also one that each lesson maintainer should lead on. How best to manage this?

drjwbaker commented 7 years ago

Why didn't we just pull across the SWC ones in the first instance? We have the page, but with just placeholder text... (eg http://data-lessons.github.io/library-shell/guide/)

drjwbaker commented 7 years ago

(for, of course, the lessons where there are SWC/DC equivalents)

drjwbaker commented 7 years ago

Okay. I've just done it for this lesson https://github.com/data-lessons/library-shell/commit/d8b0e7c9a250f7dbe283e6871594ab615371be59

weaverbel commented 7 years ago

Good work !

drjwbaker commented 7 years ago

Did one of these for Intro http://data-lessons.github.io/library-data-intro/guide/ and updated Shell http://data-lessons.github.io/library-shell/guide/ When I get a minute, I'll open an issue for each lesson to look at building Instructor Notes (then I'll close this).