mdn / content

The content behind MDN Web Docs
https://developer.mozilla.org
Other
9.14k stars 22.46k forks source link

It's hard to find marking guides in Learn #33353

Open wbamberg opened 5 months ago

wbamberg commented 5 months ago

In the original Learn area assessments, people weren't directed to the marking guides: the idea was that they would try the assessment, then ask for feedback or help in Discourse. This didn't work too well, so https://github.com/mdn/content/pull/29139 removed the bits sending people to Discourse, and added a way for people to find the marking guides so they could self-assess.

This seems like a good idea but IMO it's much too hard to find out where the marking guides are. The information is AFAICS only in the Learn landing page (https://developer.mozilla.org/en-US/docs/Learn#tasks_and_assessments), which means that to know where they are, someone really has to start at the start and read everything, which noone does.

For instance, if someone wants to learn JS they might start at https://developer.mozilla.org/en-US/docs/Learn, see "Where to start", find the JS entry, go straight to https://developer.mozilla.org/en-US/docs/Learn/JavaScript/First_steps and start reading. Now they will have no idea how to find marking guides, because they didn't read the whole landing page.

Can we have a link to the relevant marking guide on every assessment page?

bsmth commented 5 months ago

I think that's a good idea. We have 26 marking.md files in the learning-area repo:

./html/multimedia-and-embedding/tasks/images/marking.md
./html/multimedia-and-embedding/tasks/media-embed/marking.md
./html/forms/tasks/form-validation/marking.md
./html/forms/tasks/other-controls/marking.md
./html/forms/tasks/styling-basics/marking.md
./html/forms/tasks/html5-controls/marking.md
./html/forms/tasks/form-structure/marking.md
./html/forms/tasks/advanced-styling/marking.md
./html/forms/tasks/basic-controls/marking.md
./html/introduction-to-html/tasks/advanced-text/marking.md
./html/introduction-to-html/tasks/links/marking.md
./html/introduction-to-html/tasks/basic-text/marking.md
./javascript/oojs/tasks/object-basics/marking.md
./javascript/oojs/tasks/oojs/marking.md
./javascript/oojs/tasks/json/marking.md
./javascript/introduction-to-js-1/tasks/strings/marking.md
./javascript/introduction-to-js-1/tasks/math/marking.md
./javascript/introduction-to-js-1/tasks/variables/marking.md
./javascript/introduction-to-js-1/tasks/arrays/marking.md
./javascript/building-blocks/tasks/conditionals/marking.md
./javascript/building-blocks/tasks/functions/marking.md
./javascript/building-blocks/tasks/loops/marking.md
./javascript/building-blocks/tasks/events/marking.md
./accessibility/tasks/html-css/css/marking.md
./accessibility/tasks/html-css/html/marking.md
./accessibility/tasks/html-css/aria/marking.md

https://github.com/search?q=repo%3Amdn%2Flearning-area%20marking.md&type=code

So I guess that's 26 tasks to link out from.

wbamberg commented 5 months ago

Unfortunately we also have "marking-guide.md" : https://github.com/mdn/learning-area/blob/main/css/styling-boxes/cool-information-box-finished/marking-guide.md 😭 .

I count 59 pages with "learn-module-assessment" page type:

Not all of them have marking guides but they all might.

Perhaps if I make a PR for one of them so we can iterate on a design for it?