Muster für Maschinendokumentation hier im discourse

Wenn ihr als Maschinenpate ein neues Thema für eure Maschine anlegt folgt bitte folgenden Vorgaben:

  1. der erste Eintrag sollte eine Beschreibung und Übersicht zum Gerät beinhalten und nur von dem Maschinenpate und den Moderatoren änderbar sein.
    Inhalt:

Klasse
Typ: genaue Typenbezeichnung

Hinweise: z.B. was nötig ist zu wissen
Status: Funktionstüchtig ; Defekt ; Benötigt Wartung

Maschineninformationen vom Hersteller: Link zur Herstellerseite

Maschinenpate: z.B. @mario

Ort: steht auf rollbaren Schrank im Maschinenraum

Einzelteile: Anzahl der Teile -> Einzelteile des Geräts damit man besonders wenn es eingelagert ist alles findet und weiß was dazu gehört.

Status der Freigabe: “Entweder Kann von jedem genutzt werden (Grüner Punkt)” oder “Kann nur mit Einweisung benutzt werden (Roter Punkt) !!!”

offizielle Anleitung: am besten hier Hochgeladen als pdf damit wir nicht von der Verfügbarkeit auf dritt Seiten angewiesen sind

Firmenseite: Link zur Herstellerseite

Eingewiesene Personen: Personen die bereits eingewiesen sind (hier kann im Zweifel nachgeschaut werden), bitte ergänzen wer die jeweilige Person eingewiesen hat

Geschichte wie das Gerät zu uns kam: Wer war beteiligt, woher wurde es bezahlt, …
(Version des Dokumentationstemplates: 24.12.2019)


Die Einzelnen nicht fetten Erläuterungen natürlich entsprechend löschen und ausfüllen.


  1. Danach ne Antwort auf den ersten Beitrag schreiben. Der zweite Beitrag soll Raum für die Anleitung zur Nutzung der Maschine, Tipps und Materialhinweise geben und von allen ergänzt werden können. Daher diesen als Wiki(!) anlegen.

  2. Denkt an die Überschrift - diese sollte die Klasse (3D Drucker, Lasercutter, Bohrmaschine,…) und die Typenbezeichnung enthalten.

Das Template wird verändert werden und dann ist es gut, zu wissen, welche Kopien der Templates angepasst werden müssen.

Ideen:

  • Bitte schreibe klein die Version (Datum) in den Teil rein, den man kopiert.

    (Version des Dokumentationstemplates: 12.12.2019)

  • Benutze Tags, um das Template klar zu machen. Dann kann man es auch gut suchen.
1 Like

Ich fände es ganz nützlich wenn wir vielleicht noch einen Status dazu schreiben.

Beispielswiese:

Status: **Funktionstüchtig ; Defekt ; Benötigt Wartung **

1 Like

Finde ich gut. Soll ich das in die alten noch Nachtragen oder ist alles ohne Versionsnummer absofort Version 1?

Hab ich übernommen. Ist nur schwierig wenn wir mehrere z.B. Akkuschrauber haben. Dann ist ja nur 1 Defekt und nicht alle. Wie lösen wir das?
Habs aber erstmal ins Template geschrieben.

PS: Hatte solch einen Hinweis beim Absatz “Hinweise” angedacht. Ist auch gleich am Anfang. Reicht das vielleicht?
PPS: Hab es jetzt erstmal mit reingeschrieben. Finde aber das es sich doppelt.

ahh ja unter “Hinweise” gehts natürlich auch