search

carpentries / lesson-example

Example lesson using The Carpentries lesson template.
https://carpentries.github.io/lesson-example/
Other
64 stars 173 forks source link

Style guide for 'key points' #112

Open tracykteal opened 7 years ago

tracykteal commented 7 years ago

This template has a 'key points' section. As pointed out in this issue https://github.com/datacarpentry/sql-ecology-lesson/issues/129 it would be good to have some sort of guidelines or style guide for the 'key points', so we know what level of detail to include and how they should be stated.

Thanks @bsmith89 @ashander for bringing this up.

bsmith89 commented 7 years ago

One component of this discussion might be the roles for each of "questions", "objectives", and "key points". All three are part of the lesson template, and some (e.g. sql-ecology-lesson) also have "learning objectives" as the top section for each chapter.

Currently, the ecology SQL lesson is using key points as a sort of reference for the syntax and basic concepts in each chapter. But this is not how they are being used in OpenRefine-ecology-lesson. For that lesson, that role is fulfilled more by the "objectives" section of the template.