search

WordPress / Learn

WordPress.org Learn - The canonical source for the code and content behind https://learn.WordPress.org
274 stars 100 forks source link

Add Facilitator Notes area to Lessons #2855

Closed kathrynwp closed 2 days ago

kathrynwp commented 2 months ago

Summary

Let's add a new section to individual lessons in Sensei, to house "Facilitator Notes"

Purpose

The purpose of this section is to provide additional material associated with a lesson, geared to facilitators who would like to use the material to teach others. For example, content creators may include a list of prerequisites, objectives, or learning outcomes.

To keep in mind

Populating Facilitator Notes

I've separated this issue from the previous one in #2392, since we don't want to immediately run an automated content migration from Lesson Plans to Facilitator Notes, but instead undertake a more curated, manual survey of what content is currently living in Lesson Plans and what is worthwhile to move into which lesson(s), if any.

Content creators might also undertake to add certain Facilitator Notes (such as prerequisites, learning outcomes, etc.) to the Learning Pathway courses, in lieu of trying to match up older lesson plans with newer lessons.

Where to add the link

Perhaps it could go below or above "Suggestions" in the left sidebar?

theme_json_in_Classic_themes___Learn_WordPress

cc @westnz @jonathanbossenger @Piyopiyo-Kitsune

westnz commented 2 months ago

This is a tough one since having the Facilitator Notes in the course's left sidebar might be confusing. Could we explore displaying it directly on the lesson page instead? If we stick with the sidebar option, I suggest placing it below 'Suggestions,' but we'd need to add another Separator block.

jonathanbossenger commented 2 months ago

The location of the facilitator notes link should also take into account what happens when the link is clicked.

Wherever we put the link, if a new learner clicks on it and sees the content, that will cause some confusion. Perhaps placing it somewhere that's not front and center to the learner but can be documented for facilitators?

The first place that comes to mind is the WordPress admin bar.

learn wordpress org_lesson_wordpress-and-web-servers_

Then, when the link is clicked, the notes slide on from the left of the lesson, as a sticky overlay.

facilitator-1

This does mean it might overlay the lesson content a little on smaller resolutions, but as long as the facilitator can still scroll to see the content, I think that's ok.

facilitator-2

kathrynwp commented 2 months ago

Interesting idea to put it in the admin bar, but I'm concerned that it might be easily overlooked there. Since the Facilitator Notes aren't technically a WordPress/Sensei administrative action, but something visible to all (i.e. not related to editing or otherwise manipulating the lesson on the admin side.) I'm also wondering if it might not make sense to put them up in the admin area.

Looping in @WordPress/meta-design to see what ideas you might have.

jasmussen commented 2 months ago

The adminbar should never be visible to someone who isn't logged in. The fact that it is, at present, is a bug that should hopefully be fixed somewhat soon, as part of https://github.com/WordPress/wporg-mu-plugins/issues/647.

So if facilitator notes are to be visible to someone who isn't logged in, the admin-bar is a non-starter.

On the flipside, if facilitator notes should be visible only to someone who's logged in, the admin-bar may be an acceptable place.

A link at the bottom of the sidebar could be okay with me. We can even add help-text below the link, which describes in more depth what those notes are about, and who they are for.

kathrynwp commented 2 months ago

I just realized that one issue with putting it in the sidebar is that the sidebar is only visible on lessons that are contained inside published courses. Right now, we publish lessons even when the full course hasn't yet gone live (been published). For example, see this lesson in the yet-to-be-published Advanced WP User course:

https://learn.wordpress.org/lesson/why-would-a-wordpress-user-need-to-run-a-local-site/

There's no sidebar because right now it's acting as a "standalone" lesson, without being part of a published course. Down the road, once the Advanced WordPress User course is published, the sidebar will be present.

So if facilitator notes are to be visible to someone who isn't logged in, the admin-bar is a non-starter.

I think the facilitator notes should probably be available to anyone who is previewing a lesson, even if they haven't registered to take the course. Previews are available even to logged-out users.

@jasmussen Given the above factors, can you think of anywhere else to put the link/tab? Maybe somewhere in this sticky bar, circled here:

Why_would_a_WordPress_user_need_to_run_a_local_site____Learn_WordPress
jasmussen commented 2 months ago

An older post here included a tab-bar for "instructor notes", I guess that's the same?

https://make.wordpress.org/training/2024/04/29/a-light-learn-lessons-visual-refresh/

Scroll to the bottom.

jonathanbossenger commented 2 months ago

Yes, that's it. I had a feeling it was discussed somewhere, but for the life of me, I could not remember where.

kathrynwp commented 2 months ago

Thanks, both – yes that's it, and I think it looks great! Copying here:

instructor-notes

Not sure if you had this in mind, but when flipping over to the Facilitator Notes tab, we could keep the left sidebar present, so the facilitator can reference the lessons/modules while reading the notes.

kathrynwp commented 2 months ago

@adamwoodnz I think this is ready to go – please let me know if you need anything else for now. Thank you!

adamwoodnz commented 2 months ago

~Can we please have a visual for what it would look like when the notes tab is active?~

Edit: I missed this:

when flipping over to the Facilitator Notes tab, we could keep the left sidebar present, so the facilitator can reference the lessons/modules while reading the notes.

If we keep the sidebar visible I assume that means that if a sidebar link is clicked, a navigation to the lesson or quiz will still occur as usual. When that happens will the instructor notes need to remain active? By default obviously the lesson/quiz content will be shown.

jasmussen commented 2 months ago

The idea for the tabs was from @Piyopiyo-Kitsune, it's possible she has additional nuance or detail.

kathrynwp commented 2 months ago

If we keep the sidebar visible I assume that means that if a sidebar link is clicked, a navigation to the lesson or quiz will still occur as usual. When that happens will the instructor notes need to remain active? By default obviously the lesson/quiz content will be shown.

I'd love to hear what Destiny had in mind. From my POV, I think it makes sense to view the lesson whenever it's clicked in the sidebar (even if a visitor had the Facilitator Notes panel open) so that people can refer back and forth between the Facilitator Notes area and a particular lesson's content.

jasmussen commented 2 months ago

Another option is to just have a Details block at the bottom of all the sidebars in the course. Or even at the top. Not sure if we can cookie that to be open or closed, but essentially this:

Instructor notes Tada! Here's an instructor note.
kathrynwp commented 2 months ago

@jasmussen Thank you so much for that alternative idea!

I see two potential issues with this, but wonder what you think:

jonathanbossenger commented 2 months ago

Deleted my comment because I see @fcoveram has a revamped lesson flow proposal.

kathrynwp commented 1 month ago

Just wanted to note for anyone coming across this that discussion around the design of the Facilitator Notes area is now happening here:

https://github.com/WordPress/Learn/issues/2869

kaitohm commented 2 days ago

Closing in favor of #2869