Introduction

This guideline and its template are available for you and your team to follow as a reference in the process of developing your project.

To better understand guidelines development for documentation of OSH design reuse, this video presents all of the structure of guidelines documentation.

Getting started with your documentation

To get started with your documentation, you can use this template

Then, to reference this guideline, you can follow the guideline and then fill the template in each section in your own Project's readme.

At first, you should identify your needs for documentation. These needs are represented as development activities in the guideline for creating the documentation. Then, according to your required development activities, you can fill the corresponded templates of documentation blocks

Moreover, you can utilize the link of the App diagram in the template and fill the information of your product in the tables or create your representations as a graph or tree.

To use the link of the App diagram in the template, you can follow these steps to create your own project's table, graph or, tree.

• At first, use the link "Edit As New" or "Edit in diagrams.net" to go to App diagram.
• Then, you can modify the text, table, tree, or graph (image below).

• After modifying, you can save the changes.
• Finally, it is possible to export the file in different forms ( PNG, JPEG, PDF, HTML, URL,...) and import it in the readme.

Project team

• Jean-François BOUJUT {[email protected]}
• Amer EZOJI {[email protected]}
• Romain PINQUIE {[email protected]}

License

CC-BY-SA 4.0

Sponsors and Partners

The European research and innovation project OPEN!NEXT is sponsorised by the EU’s Horizon 2020 program under the grant N°.869984

. .