An open hardware handbook

This file presents a possilbe table of content for a handbook to learn how to make research hardware more open and FAIR. The idea is to list the kind of content we would like. For each (sub-)chapter, we will then - see if it can be a specific part of the turing way book - see what source can be re-used to write it (turing way book/openmaker doc/ Deflt course doc, other) - write new turing way chapter, or enhance existing ones

We may create a special built of the turing way book, choosing and reorganising these chapters.

versions: 1. discussion between JC and SA, complemented during edition by JC


1 Introduction

1.1 What is open (research) hardware

1.2 Purpose of open hardware

1.3 Working open versus publish open

1.4 Hardware development steps

1.4.1 Ideation and requirements

1.4.2 Prototypes

1.4.3 Stable release

1.4.4 Production ready

2 Hardware as a research output

2.1 (Lack of) Recognition

2.2 Publication options

2.3 Harware licenses

2.4 Making hardware citable

2.5 Making hardware discoverable

3 Open hardware project setup

3.1 Do not reinvent the wheel

3.2 Community and interested parties

3.2.1 Contributors

3.2.2 Users

3.2.3 Hardware producers

3.3 Working in the open

3.3.1 Setting your repo for collaborative work

3.3.2 Making it inclusive per default

3.3.3 Recognize and encourage contributions

3.3.4 Think long term (new maintainers)

==========================

4 Hardware maker skills

4.1 Safety knowledge

4.1.1 Electricity

4.1.2 Other

4.2 Technological skills

4.2.1 3D print

4.2.2 CNC

4.2.3 PCB

4.2.4 CAD

4.3 Project and data management

4.3.1 Data management plan

4.3.2 version control for hardware

4.3.3 Using git

4.3.4 Using issues and PR

4.4 Community building

4.4.1 Communication and forum

4.4.2 Inclusivity

4.4.3 Recognition

4.4.4

5 Hardware documentation

5.1 Content

5.1.1 User manual

5.1.2 Test and validataion

5.1.3 troubleshooting

5.1.4 maintenance

5.1.5 repair guide

5.1.6 End of life/ disposal

5.2 Form

5.2.1 Website with quarto/read the doc

5.2.2 Website with gitbuilding