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.
====== Tool Usage Guides ======

===== Purpose =====

The Tool Usage Guide content is partitioned into two parts:

  * A basic guide, suitable for students, which covers foundational information for using the tool safely in the Protohaven environment.
  * A section for member notes, including a quick reference, more advanced information, and other content that's not appropriate for learners.

These two parts are used in various ways. Class handouts include the basic guides so students have their own copy of the information they need to use the shop. Tool binders on the shop floor include both the basic guide and member notes, along with ways for members to add new information on the spot. 

===== Structure =====

Basic tool usage guide structure is as follows.

  * Tool Name
    * (Intro paragraph: what the tool is for, etc.)
    *  Notes
      * Safety
      * Common Hazards
      * Care
      * Use
      * Consumables
      * Tooling (recommendations for bringing own tooling/parts: blades, bits, cutters, etc.)
      * Materials (what can and cannot be worked with the tool)
    * Parts of the Tool
      * (Annotated Image)
      * Part Description
      * Part Description
      * Part Description
    * Basic Operation
      * Setting Up
      * Workholding
      * Using the Tool
      * Cleaning Up
      * (Special topics)

Not every subsection will be required for every tool.

Sometimes, the basic operation section may need to include an extra subsection for a //Special Topic// - a detailed discussion of something specific to that tool. Special topics should be included in the sequence of the workflow where it makes more sense (if the procedure in the special topic needs to happen before using the tool, but it before the "Use" subsection, etc.).

The member notes section structure is as follows:

  * Member Notes
    * Quick Reference
    * (Notes)

The organization of the (Notes) section above will vary from tool to tool, and may need to be periorically edited and reorganized.

===== Templates =====

Template files for creating new tool usage guides are available in the Protohaven GitHub organization:

https://github.com/protohaven/printed_materials

...or through typst.app:

https://typst.app/project/wuQAU0imr2tgjgiydfRiPX