OSHW Documentation Standards

-

REFERENCES

Industry Standards

Other

Development Standards

GENERAL GUIDELINES

Guidelines

Platform Specifications

Collaboration Tools

DEVICE INFO

Additional Info

BUILD INSTRUCTIONS

Dashboard

Mechanical Component

Electronics & Power Electronics Component

Hydraulics & Pneumatics Component

Optics Component

Chemistry Component

Software Component

Device Assembly

-DISTRIBUTIVE ENTERPRISE


NOTES

Version 1 of the documentation standards assumes availability of computers, internet access, as well as open source and freeware software. Version 2 should focus on cheaper hardware and simpler software for delivery (eg. raspberry pi and cell phones)


STEPS


Goals

Industry Standards

Manifestos

Other

Development Standards


GENERAL GUIDELINES

Guidelines

Platform Specifications

Collaboration Tools

Modules


DEVICE INFO - focus on metainfo that brings this into context of greater Open Hardware Community (Mappr semantic mapping)

About the Device (core).

Dashboard (core):

Highly recommended:

Additional Info:


BUILD INSTRUCTIONS

Sample Navigation Box

Dashboard

For each component:

Highly recommended:

Fabrication Component

Mechanical components, enclosures, etc.

Core:

Exploded view drawing

Step by step instructions IKEA-style (w/ drawings and//or photos)

Instructional videos

HowDos

Highly recommended:

Electronics & Power Electronics Component

In addition to the dashboard:

Hydraulics & Pneumatics Component

In addition to the dashboard:

Optics Component

In addition to the dashboard:

Chemistry Component

In addition to the dashboard:

Software Component

In addition to the dashboard:

Device Assembly


USER MANUAL


DISTRIBUTIVE ENTERPRISE

Core: