Example Module Template

Overview

What is this? Why does it matter? How is it used?

This explanation should make some sense even if somebody has minimal experience with the topic of the module

A more detailed explanation of the importance of this topic can be placed in summary

Installation, Configuration Instructions (As needed)

What does a student need to have installed to be able to follow along with the lecture and other activities?

Especially in the earlier modules, this should be geared towards people with very little experience

apt install this

pip3 install something

Use subheaders and/or ordered/unordered lists to organize setup if it is long.

Lecture/Tutorial

(videos)

List timestamps of the sections so that after watching the video somebody can easily return to a specific section

Written tutorial

Some modules will rely on a lecture video

This section can be used to summarize key sections from the video or link an external resource that teaches the same topic

This section is particularly important if there is not a recorded lecture yet.

If the written tutorial section is longer than a few lines:

Organize it using subheadings

This section can also expand on critical skills that are not in the video

Examples of usage can be included either under a "Examples" subheading, or within other subheadings as appropriate

Here's some example code to show the topic of this module in action

Conclusion

Key takeaways

Reminder of why this is important

If any applications of this topic required some understanding of the topic to appreciate, this would be a good spot to put them

Follow-Up Activities

Generally, these are things a student can do to implement the things already taught in this module and demonstrate competency

More complicated activities that may require non-trivial additional study can go near the end of this section

• quiz/some sort of assessment of comprehension
• learning activities (practice using skills from this module)
• ideas for related projects
• Hard project

Certify your skills

This is where we will have badge resources

Additional resources

Somewhat related to follow-up activities, but more geared towards learning additional information

Resources for the curious that may go beyond the scope of the bootcamp lecture

Can also include useful pages: documentation, free textbooks, quick-reference/cheat sheets, etc