OSHW Dashboard

Introduction

This is a standard for documenting Open Source Hardware Projects so that there is a uniform protocol for how OSHW projects are identified in the greater world of proprietary and open product development. This format was proposed as a result of the Open Source Hardware Documentation Jam of 2013.

Content

These are the essential metatags and metadescriptors to be incorporated into documentation of open hardware projects:

1. OSHW – The tags that identifies the entire project as open source hardware
2. Entity – The person or organization responsible for the project
3. Project Name – Something unique that identifies the specific project
4. Version – An alpha-numeric code that increments at milestones
5. Completion Status – The general maturity level of the project
6. Version Date – Last time the version number changed
7. Terms of Use – Any terms of use or licensing compatible with the latest version of the open source hardware definition
8. Summary – The project pitch – short (140 characters?)
9. Keywords – A comma separated list of synonyms – tags for search engine optimization
10. Description – The detailed description of the project
11. Predecessors – This project descended from…
12. Content Location – A URL to the main project repository

Example from Website

[1]

Procedure

We welcome.other projects to copy this dashboard and post their information on the OSE wiki. To do so, start a page named OSHW-YourOrganization-YourProjectName-Version on this wiki after you register for an account.

External projects and OSE projects are encouraged to use the above tags such as OSHW-OSE-CNC_Torch_Table-v1 and so on.

The template for this needs to be built to facilitate entries, under Wiki Templates.