Checkliste

Sobald alle der folgenden Akzeptanzkriterien für ein standardisiertes DIN SPEC 3105 repository erfüllt sind kann das Repository für das Peer-Review freigegeben werden. ## Lizenzablage - [x] gemäß REUSE - [x] Vorhanden für OSH - [x] Vorhanden für Dokumentation - [x] Vorhanden für Software - [ ] Die 3 Copyrightzeilen zur Liezenzzuordnung in jedem Dokument vorhanden ## BoM - [x] Die BoM ist vollständig, alle verwendeten Teile sind aufgelistet - [x] Die Bezeichnungen der Teile sind eindeutig und unmissverständlich - [x] Die Mengen sind korrekt - [x] Die Materialparameter sind spezifiziert - [X] Teilenummern/Hyperlinks stimmen mit Assembly Guideline verweisen überein - [ ] Bezugsquellen werden genannt (nice to have) ## Assembly Guideline - [ ] Werkzeuge werden gelistet - [ ] Konsistent - [ ] Hyperlinks vorhanden - [x] Bilder erklären durchführung - [ ] Unmissverständliche Dokumentation - [ ] Gefahrenhinweise vorhanden - [ ] Toleranzen der Produktionsmaschienen sind angegeben - [ ] Oberflächen Behandlungen, nacharbeiten von Teilen, zB. aus dem 3D Druck oder der Fräse ## OKH.TOML Datei - [ ] Vollständig ausgefüllt - [ ] Im Root-Folder des Repositories abgespeichert ## Formale Aspekte - [x] Markdown korrekt verwendet - [x] REUSE/Linter Prüfung bestanden ## Darstellung für Nutzende (kein notwendiges Kriterium) - [x] Gitbuilding / MkDocs optimiert - [ ] Dokumentationshandbuch wurde erstellt ## Wiederholbarkeitsgüte (kein notwendiges Kriterium) - [ ] Replizierbar durch gleiche Workshopleitung - [ ] Wiederholbar durch andere Workshopleitung ## Dokumentation des Workshops - [ ] Existiert - [ ] Fabrikationsschritte zeitl. beschrieben - [ ] Raumanforderungen beschrieben - [ ] Werkzeugmenge beschrieben - [ ] Teilnahmevorraussetzungen beschrieben - [ ] Workshopinfo Datenblatt abgelegt ## Designfiles - [ ] CAD Files als stl lesbar - [ ] CADs auch als Bild oder in .pdf einsehbar - [ ] Die Designfiles sind vollständig, alle Teile wurden gezeichnet - [ ] Dimensionen sind mit angegeben - [ ] Alle für die Herstellung notwendigen Infos sind vorhanden - [ ] Die Ansicht der Daten ist sinnvoll skaliert - [ ] Teilenummer stimmt mit BoM und Assembly Guideline überein (konsistent) - [ ] Schaltkreise auf Platinen (PCB) als KiCAT gesondert in Ordner /elec abgespeichert ## Software und Firmware (falls vorhanden) - [ ] Firmware ist im Repository abgelegt oder eine Software zur Verwendung der OSH verlinkt - [ ] Eine Guideline für diese Firmware bzw. Software wurde erstellt ## Ordnerstruktur - [ ] gemäß Template - [ ] Subrepository für Binary Files

swendel commented

2022-11-11 14:31:07 +01:00

Owner

Sobald alle der folgenden Akzeptanzkriterien für ein standardisiertes DIN SPEC 3105 repository erfüllt sind kann das Repository für das Peer-Review freigegeben werden.

Lizenzablage

gemäß REUSE
Vorhanden für OSH
Vorhanden für Dokumentation
Vorhanden für Software
Die 3 Copyrightzeilen zur Liezenzzuordnung in jedem Dokument vorhanden

BoM

Die BoM ist vollständig, alle verwendeten Teile sind aufgelistet
Die Bezeichnungen der Teile sind eindeutig und unmissverständlich
Die Mengen sind korrekt
Die Materialparameter sind spezifiziert
Teilenummern/Hyperlinks stimmen mit Assembly Guideline verweisen überein
Bezugsquellen werden genannt (nice to have)

Assembly Guideline

Werkzeuge werden gelistet
Konsistent
Hyperlinks vorhanden
Bilder erklären durchführung
Unmissverständliche Dokumentation
Gefahrenhinweise vorhanden
Toleranzen der Produktionsmaschienen sind angegeben
Oberflächen Behandlungen, nacharbeiten von Teilen, zB. aus dem 3D Druck oder der Fräse

OKH.TOML Datei

Vollständig ausgefüllt
Im Root-Folder des Repositories abgespeichert

Formale Aspekte

Markdown korrekt verwendet
REUSE/Linter Prüfung bestanden

Darstellung für Nutzende (kein notwendiges Kriterium)

Gitbuilding / MkDocs optimiert
Dokumentationshandbuch wurde erstellt

Wiederholbarkeitsgüte (kein notwendiges Kriterium)

Replizierbar durch gleiche Workshopleitung
Wiederholbar durch andere Workshopleitung

Dokumentation des Workshops

Existiert
Fabrikationsschritte zeitl. beschrieben
Raumanforderungen beschrieben
Werkzeugmenge beschrieben
Teilnahmevorraussetzungen beschrieben
Workshopinfo Datenblatt abgelegt

Designfiles

CAD Files als stl lesbar
CADs auch als Bild oder in .pdf einsehbar
Die Designfiles sind vollständig, alle Teile wurden gezeichnet
Dimensionen sind mit angegeben
Alle für die Herstellung notwendigen Infos sind vorhanden
Die Ansicht der Daten ist sinnvoll skaliert
Teilenummer stimmt mit BoM und Assembly Guideline überein (konsistent)
Schaltkreise auf Platinen (PCB) als KiCAT gesondert in Ordner /elec abgespeichert

Software und Firmware (falls vorhanden)

Firmware ist im Repository abgelegt oder eine Software zur Verwendung der OSH verlinkt
Eine Guideline für diese Firmware bzw. Software wurde erstellt

Ordnerstruktur

gemäß Template
Subrepository für Binary Files

swendel added this to the project finalisation milestone 2022-11-11 14:31:07 +01:00

swendel self-assigned this 2022-11-11 14:31:07 +01:00

swendel added this to the documentation project 2022-11-11 14:31:08 +01:00

Checkliste #23