Die Erstellung guter offener Dokumentationen ist aufwendig, jedoch essentiell für die Entwicklung eines OSH-Projekts und den Aufbau einer Community. Der neue Community-Review-Prozess nach DIN Spec 3105 ist so arbeitsintensiv wie lohnenswert, denn er bringt OSH-Projekte ein gutes Stück weiter.
Nachdem 2020 die DIN Spec 3105 zu Open Source Hardware offziell veröffentlicht wurde, stellen sich nun Fragen wie:
- Ist es überhaupt sinnvoll, Open Source Hardware zu reglementieren?
- Kann Open Source Hardware mit dieser DIN Spec zuverlässiger und professioneller gemacht werden?
- Reicht die DIN Spec 3105 aus, um der Vielfältigkeit von Open Source Hardware Projekten gerecht zu werden?
- Sind die dort aufgestellten Vorgaben und Abläufe überhaupt sinnvoll?
Um das herauszufinden, haben wir Anfang des Jahres 2021 damit begonnen, 15 OSH-Projekte genauer unter die Lupe zu nehmen.
Dokumentationsvorbereitung
In der ersten Phase unterstützen wir die Projekte dabei, ihre Dokumentation für den Review-Prozess vorzubereiten:
Ist eine Stückliste vorhanden? Gibt es eine Zusammenbauanleitung oder -zeichnung? Sind die Dateien in einem Format, das den Anforderungen der DIN Spec entspricht? Laut DIN Spec müssen für alle projektspezifischen Teile sowohl die Sourcedatei (Modifizierbarkeit) als ggf. auch ein Exportformat (Nachbaubarkeit) vorliegen, damit jedes Teil leicht verändert werden kann und ein Nachdruck oder -bau auch ohne u.U. spezielle Programme möglich ist. Für einen genaueren Überblick dazu ist die offizielle DIN Spec 3105 hier einsehbar.
Kennst du ein Projekt, das an der Verbesserung seiner Dokumentation interessiert ist?
Reviewer-Suche und Prozessgestaltung
Anschließend begaben wir uns auf Reviewer*innen-Suche für die einzelnen Projekte. Für jedes Projekt sollte es jeweils zwei Reviewer*innen geben, deren Vorwissen in etwa mit dem Themenfeld des Projekts übereinstimmen sollte. Manche Projekte schlugen von sich aus interessierte Personen vor, während wir für andere Reviewer*innen in der Open Source Ecology Community Ausschau hielten.
Hättest du Lust eine Open-Source-Hardware-Dokumentation zu reviewen?
Die DIN Spec gibt für die Prüfung zwar den groben Rahmen vor (mind. zwei Reviewer*innen und ein Conformity Assessment Body), hält sich im Bezug auf den Ablauf aber eher bedeckt. Wir, der Open Source Ecology Germany e.V., treten mit diesem Projekt nun erstmals als Institution „Conformity Assessment Body“ auf und unsere Aufgabe ist es, diesen Review-Prozess zu gestalten, zu begleiten und anschließend sowohl die Ablaufdokumentation als auch die begutachtete Projektdokumentation zu archivieren.
Um einen ersten Verfahrensprototypen zu entwickeln, haben wir uns für das vereinseigene Gitlab entschieden. Alle Projekte und die dazugehörigen Reviews können hier nachgeschlagen werden.
Erkenntnisse der Community Reviews
Im Laufe der Community Reviews der circa 15 Projekte aus den letzten sechs Monaten haben wir einiges gelernt.
„Great experience for testing this on GitLab. Keep getting feedback will definitely improve the process!“
Reviewer Feedback
1. Nachbauer sind die besten Reviewer.
Ein*e Reviewer*in, die Interesse hat, das Projekt anschließend nachzubauen, setzt sich sehr genau mit der Dokumentation auseinander und betrachtet diese auch aus der Sicht der Nachbaubarkeit. Das führte zu sehr hilfreichen Kommentaren und brachte die Projekte weiter.
2. Open Source Hardware Projekte profitieren doppelt.
Die Dokumentation eines OSH-Projekts profitiert enorm von einem kritischen und unabhängigen Vier-Augen-Prinzip. Unverständliche Bauteilbeschreibungen werden vermieden, fehlende Mengenangaben entdeckt – und manchmal braucht es einfach einige Bilder, um Anleitungen hinreichend zu veranschaulichen.
Des Weiteren unterstützt der Review-Prozess den Community-Aufbau, denn durch das Review werden bereits mind. zwei Personen näher an das Projekt herangeführt, wodurch sie sich intensiv damit auseinander setzen müssen.
3. Motivation als Erfolgsfaktor
Natürlich steht und fällt auch hier alles mit dem Zeitaufwand der Projekte und der Motivation, den die Reviewer*innen mitbringen. Bei zwei Projekte konnten wir den Review-Prozess leider nicht beginnen, weil die Dokumentation nicht rechtzeitig fertig wurde. Drei weiteren Projekten konnte der Titel Open Source Hardware leider nicht verliehen werden, weil angefragte wichtige Nachbesserungen der Dokumentation noch nicht stattgefunden hatten.
4. Plattform-ungebundenes Reviewen
Ein Projekt profitiert von der Analyse seiner Dokumentation umso mehr, wenn die Reviewer*innen nicht unsere Vereinsplattform, sondern die projekteigene nutzen, denn so testen sie gleichzeitig den Aufbau der Dokumentation und Partizipationsmöglichkeiten über verschiedene Plattformen und Websiten hinweg.
“Wir haben es geschafft, Open-Source-Hardware-Projekte bei ihrer Dokumentation zu unterstützen und sie in Austausch mit der Community zu bringen.”
CAB ADMIN Feedback
Community Review durch Nachbauen
Nach diesen intensiven und leerreichen ersten Review-Durchläufen können wir nun bestätigen, dass es sinnvoll ist, die Dokumentation von Open Source Hardware zu prüfen, um sie zu verbessern. Nicht nur die Projekte profitieren davon, auch werden es zukünftige Nachbauer*innen einfacher haben und potentielle Weiterentwicklungen erleichtert.
Trotzdem tauchte oft die Frage auf: Müsste ich das OSH-Produkt für ein vollständiges Review nicht nachbauen?
Richtig, theoretisches Überprüfen von Nachbaubarkeit ist fehlerbehaftet und ersetzt somit einen tatsächlichen Rebuild nicht, denn ist ein Projekt tatsächlich nachgebaut worden, beweist das besser als alles andere, dass die Dokumentation ausreicht. Wird solch Nachbau nun mit dem entwickeltem Review-Prozess verbunden, kann sich ein Projekt anschließend recht sicher sein, dass die Dokumentation vollständig und korrekt ist.
Dahin soll die Reise gehen. In den Folgeprojekten des Vereins sollen OSH-Projekte nicht nur theoretisch geprüft, sondern auch praktisch reproduziert werden. Und auch die DIN Spec (Community Repo) wird um diesen Aspekt erweitert werden. Es bleibt also spannend. Wollt ihr selbst mit Hand anlegen beim Nachbauen oder Reviewen? Kennt Ihr Projekte, für die ein Review-Prozess interessant sein könnten?
Call for Action
Fallen euch Open-Source-Hardware-Projekte ein, die Interesse an einem Community Review hätten?
Wollt ihr selbst aktiv werden und Projekte dabei unterstützen, bessere Dokumentationen zu liefern? Dann meldet euch als Reviewer*innen!
Kennt Ihr ein Projekt, das unbedingt mal nachgebaut werden sollte?
Dann immer her damit: Kontakt
„DIN is a respected institution. It’s important for me to have this certification.„
“My project documentation improved thanks to this program.“
Projekt Community Feedback
Wir bedanken uns bei der Postcode Lotterie für die Finanzierung dieses Projekts und den vielen ehrenamtlichen Reviewer*innen, die viel Zeit aufgebracht haben, um unser Vorhaben überhaupt möglich zu machen.
[1] https://gitlab.opensourceecology.de/verein/projekte/cab
[2] https://blog.opensourceecology.de/de/category/ose-community
[3] https://din.one/pages/viewpage.action?pageId=36603169
[4] https://gitlab.com/OSEGermany/OHS-3105
