How to - Document a Machine

From CoMakingSpace Wiki

All our machines are being recorded in our wiki. Thank you for helping with this!

If you want to get a head-start with your machine, please head over to Create Page and start creating the page from there. It will pre-populate the new page with the basics needed for every machine.

Page Title

The title of machine pages follow a strict schema: 

<<MANUFACTURER>> <<MODEL NAME>> <<(if needed: Number)>>

So, for example, if your machine is a new machine made by Bosch with the model name GCM 12 GDL, the respective machine page would be called Bosch GCM 12 GDL.

If there are multiple machines with the same manufacturer and model name, we add (1), (2), etc. to the machine page, leading to:

Makita DDF483 (1) and Makita DDF483 (2).

If you are unsure, what would be the correct naming, please still go ahead. We can always rename the page!

Content

Machine Infobox

Any machine page contains an infobox, which is added by using the Template MachineInfoBox. This Infobox provides an overview of the most important facts about the machine. It is also the base for some automagical things happening in the wiki and other systems.

You can help a lot by filling the available parameters for the infobox. The moste important ones are the name of the machine (the same as your page title), the image and the "german" parameter, which gives the german name of the machine.

Another important parameter is the assetid. This parameter can be provided by Johannes.

Commissioning Template

While the machine you are documenting is getting ready to be used, the Template:Commissioning is added to the page.

This template provides an overview of steps that need to be taken until the new machine is up and running in one of our workshops. Once a specific step was done, please indicate the same by setting the respective status parameter to "Done".

Further Content

The further content needed on the page varies a lot between different machines.

Please add at least the following:

  • Main Specifications

Furthermore, please think especially of adding the following:

  • Limitations
  • Known Issues & Possible Workarounds
  • Applied Repairs
  • Consumables
  • Accessoires

Automatic Syncs Based on Asset ID

As soon as your machine was inventorized and an assetid was assigned, a few automatic synchronization thing will happen:

  1. The fields "Type", "Location" and "Status" get populated
  2. The fields "Access Requirements" and "Tutor" get populated if an introduction is assigned to the respecitve machine type
  3. The machine shows up on the page of the respective machine type
  4. The machine shows up on the page of the respective location
  5. The machine shows up on our website

Steps 3-5 can be dependent on the location not being the office and the status being "Working".

Retrieved from "https://wiki.comakingspace.de/index.php?title=How_to_-_Document_a_Machine&oldid=19514"