Jun/Jul 2024 Modules Development Sprint

[cynthiahqy]

Module development plan for Jun/Jul 2024 sprint

Team

• Mitch: infrastructure & module design
• Cynthia: governance & module design
• Rob: funding/contracts
• Kris & Taysha: module creation (and possibly design)

Communications

• Overall project management things --> THIS pinned issue!
• General notes, ideas for specific content --> Relevant content Issues
• Review, feedback and troubleshooting on specific modules/content --> Pull request associated with that content
• Anything else --> Google Chat or email.

Content Development Workflow

1. Pick a content issue and assign yourself, (make sure it has a branch attached)
2. Fork the repository
3. Create and check out a branch for your content, add an initial commit (i.e. outline), push back to GitHub.com
4. Start a pull request from your branch to the relevant issue branch under numbats/monash-learnr-modules
5. Tag @mitchelloharawild or @cynthiahqy to review the outline.
6. Develop content and add commits to your forked branch. The commits will automatically be added to the pull request. If you have specific content or debugging issues, be sure to reference the specific commit(s) where you need help/clarification.
7. Once you finished your module, tag @mitchelloharawild or @cynthiahqy. We will review the module and merge it into the website.

Module Requirements

A module must have:

• [ ] Related Content Issue & Pull Request
• [ ] Outline

Modules will contain some combination of:

• [ ] Written Content (instructions/explanations)
• [ ] Exercises
• [ ] Video (optional)
• [ ] Additional Resources (outlinks, cheatsheets etc.)

Other housekeeping

• [ ] Content License #11
• [ ] Priority Content
• [ ] Workflow
• [ ] Presentation structure -- organising structure for modularity

[mitchelloharawild]

Draft Module Plan -- See this Google Doc for updates

Core Skills

1. 7 (Krisanat)

2. 16 (objects, using functions, lists/data frames, understanding messages/warnings/errors) (Tashya)

3. 12 (Tashya)

4. 17 (Krisanat)

5. 8 (Tashya)

Data Analysis 101

1. 9 (Tashya)

2. 13 (Krisanat)

3. 18 (Krisanat)

4. 19 (Krisanat)

5. Add Quarto for Communicating Data (Tashya)

We want to focus on polishing Core Skills modules by start of semester two. Tidyverse Intro should be filled out, but maybe not all bells & whistles.

These units are supplementary to MBAT course, so consider how they integrate with the MBAT units -- especially where you've noticed your colleagues have had issues.

[cynthiahqy]

Skeleton modules

• looking at other courses; what modules are needed, and overarching examples & narrative
• onboarding -- design with video in mind; fill in structure -- quality edits only, no content changes.
• @mitchelloharawild 1-4
  • [ ] forms, videos -- infrastructure stuff
  • [x] squash git history
• @cynthiahqy 5-6 / other tidyverse course
  • [x] example module (with outline on guidance)
  • [x] example issue covering multiple modules
  • [x] setup branch protection
  • [x] try fork/pull request to branch connect to issue workflow
    • forking main is probably fine; contributing back to a branch means that two people can work on the same content branch & content is not added to the repo until completed.
• thematic vs narrative cohesion.

[mitchelloharawild]

Teaching/thematic design inspiration: https://tinystats.github.io/teacups-giraffes-and-statistics/index.html We don't need (or want) such a lengthy narrative like this, but similar cohesion across modules is valuable.

Another good example of cohesive modules is https://javascript.info/

[cynthiahqy]

Principles for teaching R that can be adapted:

• https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1012018

[cynthiahqy]

For approaches to Core Skills -- https://education.rstudio.com/learn/beginner/

[cynthiahqy]

Things in addition to content we are iterating on:

• presentation of modular (interactive) content:
  • organisation into pages, sections etc.
  • cross-linking
• teaching & engagement methods
  • design of interactive exercises
  • overall narrative structure

[cynthiahqy]

• Guidelines on how to style the document (bold, italics, etc.), along with other generally useful css such as highlighting
• Don’t commit .Rhistory
• Minimal R package dependencies for documents