[Review][Main] General Overview

[josch-a]

Overview for the Community Review of [PROJECT]

Assessment Status

1. OSHWA certification? If available license and source files under 2. is fulfilled
2. Technical Documentation fulfills requirements for application
   • Compatible licenses
   • Source files available
   • Export files for special parts provided
   • Bill of Materials available
   • Assembly instructions provided
3. Assessment preparation (CAB-Admins)
4. Reviewers found and assigned
5. Assessment started
6. Assessment finished

[josch-a]

As a basic summary there are still many basic elements missing which need to be fulfilled for a useful technical documentation (especially acc. to DIN SPEC 3105, but also general). Please find some basic guidelines here:
Background info and guidelines:

• Best Practices for Open Source Hardware 1.0 | OSHWA
• DIN SPEC 3105 - Open Source Hardware -- Part 1: Requirements for technical documentation
• Technology-specific Documentation Criteria for Open Source Hardware

For detailed feedback, please check the detailed issues in this repo:

• [Review][SW] Documentation of software and firmware #7
• [Review][SET] Setup instructions for usage of the hardware #6
• [Review][OTH] All other docs/assets/auxiliary documentation #5
• [Review][LEG] Legal requirements, Information on the used license(s) for design, hardware, software and documentation #4
• [Review][ASM] Assembly instructions for construction of hardware #3
• [Review][COM] Components: The modules used in the hardware construction #2

[josch-a]

General
There are very detailed architectural drawings but most of the other technical info is missing both the technical rational/ design but also the actual manufacturing/ design files. Is that representing the current status of your technical design?

Versioning and Product life-cycle management

• Is versioning scheme existing and comprehensive?
• Is versioning scheme followed properly
• Is versioning also traceable on the actual files
• Best practice: Is the production date and location traceable on the actual product?

Hosting your Design Files

• the git-based hosting serves well for the purpose of traceable and reproducable OpenSource documentation.
• remark: History folder not necessary (creates unnecessary large Github repositories), because Git does versioning and file history automatically (PLM)
• what is the purpose of project logs?

Visualizations - Photos/ Renderings + Introduction
the provided visualization are well made and helpful to give an idea about the project. They serve well the general description in the top level readme-file.