Update review guide authored by Lukas Schattenhofer's avatar Lukas Schattenhofer
......@@ -53,35 +53,49 @@ All relevant discussions & decisions are directly documented in the issue as com
What makes open source hardware different from prorietary hardware is it's technical documentation. DIN SPEC 3105 is the first official standard defining concrete requirements (DIN SPEC 3105-1) and how to check them (DIN SPEC 3105-2). It is itself the first official open source standard. Hence, if you find some requirements overly demanding, too vague, missing etc. file an issue or merge request in the original repository ([https://gitlab.com/OSEGermany/OHS](https://gitlab.com/OSEGermany/OHS)) so we, the community, can take care of it.
### In Short
#### License
### License
The License must be compliant to the [OSHWA definition](https://www.oshwa.org/definition). We maintain a [list of compliant licenses](3-Further-Information/OSH-licenses); ask a CAB Admin for help if needed.
#### Documentation
### Documentation of Hardware
1. The documentation must be permanently and publicly accessible. When you are seeing this OSH project on [https://gitlab.opensourceecology.de/](https://gitlab.opensourceecology.de/) this is already the case
##### Different types of parts
#### Different types of parts
Engineers shall be enabled to fully understand, build and modify the design only by the given documentation. So for different types of parts different information must be provided.
###### Proprietary/Buy Parts
##### Proprietary/Buy Parts
It needs to be clear from the description of the part what you should buy. Links to Online Retailers are nut sufficient because the links can expire and then all information is lost. However they are nice to have to get a first idea of the part.
###### Standard Parts
##### Standard Parts
Standard parts (such as screws, nuts, bolts....) need to be described with their accurate name. For example: DIN 965 A2 M5X40
###### Unique Parts
##### Unique Parts
The parts individual to the project are also Open Source Hardware. The design files must be provided in their original file format and a generally accessible export format so that users a) can modify the documentation and b) have a fair chance to access the information without special or expensive software.
The format of sources and exports can vary. The source files depend on the CAD or PCB software used. Export formats should depend on the use case. For 3D-printed parts .stl or .step parts are most useful, while for milled or lathed parts technical drawings in PDF-format are most useful. Additionally there might be files to directly manufacture them. Please check if at least export format and source file is there for every part!
If the project uses FreeCad as CAD software it is enough to have only the source hence everybody can open this files with the free software.
**Even shorter:** Would you be able to build and modify this hardware only by the given documentation?
### Software
In case there is Software needed for the project. Can you access it?
Do you understand how to use it?
### Bill of Materials - BoM
Is there a list of Materials mentioning all parts need to build the project? Do you understand it and is there sufficient description for each part.
### Assembly instructions
Do you understand on how to put all parts together to build the piece of hardware?
Are parts mentioned that you did not encounter in the BoM?
Do you understand how to use the software, if there is software or firmware?
### In Short
Would you be able to build and modify this hardware only by the given documentation?
* Yes → approve
* No → state misalignment so it can be fixed
......
......