Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UPDATE: Configure Dependabot security updates on your GitHub repo #48

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

a-a-ron
Copy link
Collaborator

@a-a-ron a-a-ron commented Sep 28, 2022

The purpose of this PR is to see how we can increase the completion rate and improve the user experience. Below is the August data for this module:

Module Completion Rate # completed / # started
Configure Dependabot security updates on your GitHub repo 16.57% 28/169

For reference: See the parent issue for context

Module file structure

Screen Shot 2022-09-28 at 2 09 35 PM

Items to review for this module

We need to conduct a performance review on each of these modules to see how we can increase the completion rates, improve the user experience, and maintain the level of quality that we set for our learners.

Items for consideration

  • Thoroughly review the module content for flow, narrative, and length
    • Review use of images, tables, and other visual elements
    • Does the content read like a doc or like a conversation guide?
    • Does the estimated time to complete each unit remain accurate?
  • Review the introduction unit
    • Does it capture your attention?
    • Does it contain repetitive content from the course title page?
    • Do the learning objectives/scope align with the content?
    • Does the target audience match the content?
    • Do we accurately describe the module and learning objectives? (Is it possible that learners start the course thinking it's one thing to find out it's another?)
  • Review the module exercise
    • Does it work?
    • Does it enforce a learning objective?
    • How is it placed in the module? Should we move it around?
    • Do we need other exercises?
  • Review the questions at the end of the module
    • Do the questions test on content taught in the module?
    • Do the questions follow best practices for item writing?

Estimated Work Effort

Task Hours
Detailed module review 18 hours
Action items as identified from review TBD

There seemed to be a lot of learning objectives and to me it seemed overwhelming so I tried to pare them down and changed them to reflect the unit titles to further provide insight to the learner.
When I reread this section I felt myself a bit confused by the unit name and why it didn't outwardly have something to do with Dependabot. So I retooled the dependabot section to come first that way we introduce how the dependency graph and the GitHub Advisory Database build into Dependabot.
@camihmerhar
Copy link
Collaborator

Action Items For Each Module

  • Thoroughly review the module content for flow, narrative, and length
    • Review use of images, tables, and other visual elements
      - Yes, to me they do.
    • Does the content read like a doc or like a conversation guide?
      - I would say more like a conversation guide, but because this unit has a lot of subsections with steps to enable certain settings it does read like a manual from time to time but I don’t think it deters in those sections from learners reading it, but it makes it easier for them.
  • Review the introduction unit
    • Does it capture your attention?
      - I believe so. I think mentioning security in the opening sentence of the introduction page helps draw learners in.
    • Do the learning objectives/scope align with the content?
      - From my perspective they did not. I think it might be worth having a conversation about how the learning objectives are meant to interact with the reader. As they are right now, the learning objectives for me at least, took a long time to digest and only after walking through the entire module could I say yes I got that information from this content. For me at least I think the learning objectives do 2 things. 1) Takeaways the learner will have after going through the module. But more importantly 2) prepare the learner for what exactly is to come in the module.
    • Does the target audience match the content?
      - I believe so. From my perspective this seems like a high level summary of what someone should know about Dependabot and its security functionality.
    • Do we accurately describe the module and learning objectives? (Is it possible that learners start the course thinking it's one thing to find out it's another?)
      - I think we were a bit off with the learning objectives, but hopefully that will change with the updated ones
  • Review the module exercise
    • Does it work?
      - I might be doing something incorrect, but I wasn’t sure what the instructions were post duplicating the repo.
    • Does it enforce a learning objective?
      - Maybe?
    • How is it placed in the module? Should we move it around?
      - I think it makes sense where it is currently.
    • Do we need other exercises?
      • I don’t believe so.
  • Review the questions at the end of the module
    • Do the questions test on content taught in the module?
      - Yes
    • Do the questions follow best practices for item writing?
      - I believe so.

Updated learning objectives to be consistent with the updated ones in the Introduction unit
Added a period between "enable," and "view,".
Updated this to reflect the new exercise David created. I also copied the content from one of our higher completed modules, [Create and publish a custom GitHub actions](https://learn.microsoft.com/en-us/training/modules/create-custom-github-actions/exercise-create-custom-action) -- Let me know your thoughts!
@rmallorybpc rmallorybpc added the review For review by Aaron label Nov 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants