Protohaven Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Content, Structure, and Templates for Class Handouts ======

===== Purpose =====

These handouts are not meant to be comprehensive guides to using all parts of a tool or process. Instead, they are meant to supplement and reinforce the content covered in the class, so that the student can study the class content on their own time: provide the student with a good baseline of knowledge, go over details that the student may have missed in the moment, reinforce concepts, refer to specific steps, etc.

These handouts are not meant to be clearance checklists. 

=== Student Needs ===

Something we want to keep in mind for these documents:

//Do they succeed as a student reference?// 

Is there appropriate information in this document (not too much, but nothing critical is missing) to support students after the class is over:

  * Safety warnings to keep students safe
  * Usage notes so that students don't miss any steps (that they may have forgotten)
  * References so that students buy appropriate consumables, materials, etc.

=== Teaching Goals ===

There is space in these documents (Under "Learning Objectives") for a quick summary of the class activities and goals so that students can re-orient themselves to their experience when looking at the class notes later. 

This content is going to depend on the instructor and the material covered; if useful, we can make (and track) versions of these documents for specific courses.

===== Structure =====

The draft guidance for class handout structure is as follows.

(Inclusions are parts of the document that are imported from a separate file, to help keep the information consistent across all classes.)

  * Welcome
    * Shop Rules (inclusion)
    * Tool Status Tags (inclusion)
    * Filing a Tool Report (inclusion)
  * Class Safety Notes
  * Introduction
    * Learning Objectives
    * Terminology (individual terms are inclusions)
  * Tools Relevant to the Class
    * Tool Subsection (inclusion)
    * Tool Subsection (inclusion)
    * ...
  * Software Relevant to the Class
    * Software Subsection (inclusion)
    * ...
  * Concept Relevant to the Class
    * Concept Subsection (inclusion)
    * ...
  * Resources
  * Acknowledgements

The Resources and Acknowledgements sections can be included as needed.

===== Templates =====

Template files for creating new class handouts are available in the Protohaven GitHub organization:

https://github.com/protohaven/printed_materials

...or through typst.app:

https://typst.app/project/wuQAU0imr2tgjgiydfRiPX