Differences

This shows you the differences between two versions of the page.

--- tooldocs [2025-06-17 15:18] – aria
+++ tooldocs [2025-06-17 15:40] (current) – aria
@@ Line 5: / Line 5: @@
   - One or more tool owners, who have a good idea how it works & how to use it. These don't need to be the actual 'owners', if it's a long term loan.
   - A risk assessment, if it has any non-negligible risk. If you're not sure, ask!
-  - A training syllabus, usually. You //may// be able to skip this if:
+  - A training syllabus, usually. You //may// be able to skip this
-    - There's no risk assessment, or the risk assessment doesn't say "users will do <X>"
-    - The tool has a manual, and we use it like in the manual
   - A wiki page, which lists all of the above
@@ Line 58: / Line 56: @@
 ===== 3. Training syllabus =====
-TODO
+If:
+  - There's no risk assessment, or the risk assessment doesn't say "users will do <X>" AND
+  - The tool has a manual, and we use it like in the manual
+then you don't need this - delete the ''%%syllabus.md%%'' file you generated in the previous step, and do the normal push to your fork & make a PR thing.
+Otherwise, there needs to be some checklist for what people need to know before using your tool. This is true regardless of if the tool is access controlled or not.
+**You don't need to write a whole training course.** Since the training will only ever be given by someone who knows what they're doing, you normally only need a list of headers with some reference information. Here are some known-good training syllabuses (shortest to longest), and their source code:
+  - [[https://edinburghhacklab.github.io/hacklab-training/syllabuses/Workshop/Sander/Sander-training-doc.pdf|Sander]], [[https://github.com/edinburghhacklab/hacklab-training/blob/main/syllabuses/Workshop/Sander/syllabus.md|source]]
+  - [[https://edinburghhacklab.github.io/hacklab-training/syllabuses/Workshop/TIG%20Welder/TIG-Welder-training-doc.pdf|Welder]], [[https://github.com/edinburghhacklab/hacklab-training/blob/main/syllabuses/Workshop/TIG%20Welder/syllabus.md|source]]
+  - [[https://edinburghhacklab.github.io/hacklab-training/syllabuses/Workshop/CNC%20Router/CNC-Router-training-doc.pdf|CNC Router]], [[https://github.com/edinburghhacklab/hacklab-training/blob/main/syllabuses/Workshop/CNC%20Router/syllabus.md|source]]
+As well as the actual training documentation, we also generate a training card, which lets instructors keep track of a person's progress. Double-check that this looks OK too. (TBD: policy on when we have to get these signed, and when they're optional)
+Once you're happy with your changes, push them up to your fork and make a pull request.
 ===== 4. Wiki page =====
-TODO
+Wiki pages are where we put non-safety-critical stuff contributed by members. For convenience, you should link to the documents you made above, and list any model numbers, etc. Here's a template you can copy-paste:
+<code>
+^ [[https://edinburghhacklab.github.io/some/link|Risk assessment]] | [[https://edinburghhacklab.github.io/some/link|Training syllabus]] |
+^ Model number | C6903-NICE |
+^ Responsible people | <your names and/or discords> |
+^ Manufacturer info | <link to manual, software, etc> |
+</code>