curriculum icon indicating copy to clipboard operation
curriculum copied to clipboard

Layout guide: Each lesson to have a "Summary" section

Open nik-rev opened this issue 1 year ago • 7 comments

Checks

Describe your suggestion

I think it would be nice to have a conclusion for every lesson. Some lessons are very long and contain a lot of information. A summary section would contain a brief recap of everything learned in the lesson.

This would be beneficial because it would serve as a nice recap. I saw this on some other sites like javascript.info and I feel that summarising all of the info is a really good way to get information to stick

An example is given in a comment below

Path

Foundations, Ruby / Rails, Node / JS

Lesson Url

Curriculum

(Optional) Discord Name

Revenco

(Optional) Additional Comments

No response

nik-rev avatar Mar 17 '24 16:03 nik-rev

The Lesson Overview section already acts as a summary.

cakegod avatar Mar 18 '24 00:03 cakegod

The Lesson Overview section already acts as a summary.

It's more of an overview than a summary. A summary would be something like (for the Variables and Operators lesson):

Summary

  • JavaScript files have the .js extension
  • Variables are storage containers for data in javascript
  • Variables declared with let can be re-assigned
  • Variables declared with const cannot be reassigned and will throw an error on attempt to do so
  • The modulus (%) operator returns the remainder of a division
  • etc

nik-rev avatar Mar 18 '24 00:03 nik-rev

Yes, but they do more or less the same thing. This new section will likely just mirror the content of the Lesson Overview with a different wording.

cakegod avatar Mar 18 '24 18:03 cakegod

Yes, but they do more or less the same thing. This new section will likely just mirror the content of the Lesson Overview with a different wording.

Yeah, I can see where you are coming from. Many of the bullet points in this section could cover the same ideas as in the lesson overview

Although I think they would be different enough, repeating things helps. Who knows it may actually be useful to people, or maybe not. Just throwing this random idea out there.

nik-rev avatar Mar 18 '24 19:03 nik-rev

I personally like this idea, I think spaced repetition is important for learning and repeating concepts in a summary can help folks with building understanding (especially for longer lessons). Many lesson articles do this already in the form of a conclusion paragraph. I agree it would take quite a bit of work to do this for each lesson

jwaddell10 avatar Mar 26 '24 23:03 jwaddell10

Not entirely sure we need this per se, primarily because like Cake said, it'd effectively be a different way of wording the lesson overview and even the knowledge check to some degree. Given the scale of work such an additional requirement would entail, I don't think this is the right move for that amount of work.

Just so you know, there has been some light internal discussion about how we may want to rethink the knowledge check section as a whole across the curriculum. But again, this would lead to a very large scale job and would need the right alternative to justify that. It's a pretty low priority discussion for now as well, given other jobs going on.

mao-sz avatar Apr 09 '24 00:04 mao-sz

This issue is stale because it has had no activity for the last 30 days.

github-actions[bot] avatar May 09 '24 01:05 github-actions[bot]

Looks like this isn't being considered, closing this

nik-rev avatar Jul 03 '24 19:07 nik-rev