Documentation Taxonomy - Refactoring: Difference between revisions

From Open Source Ecology
Jump to navigation Jump to search
Line 12: Line 12:


=Going Forward=
=Going Forward=
*See graphical representation of documentation requirements - [https://docs.google.com/drawings/d/1HJa6yWnQvXVHd72nemBcIkB67-w5RZBMJQlIeyc87M4/edit]


Based on feedback:
Based on feedback:
*Distinction should be made between Source Code (actual designs) and Metadata (dashboard) and Processes (fabrication)
*Distinction should be made between Source Code (actual designs) and Metadata (dashboard) and Processes (fabrication) and Development Process.

Revision as of 20:59, 13 April 2013

Existing Best Practices & Taxonomies

  • OSHWA Best Practices for Open Source Hardware by David Mellis - [1]
  • OSE Taxonomy - OSHW Documentation Taxonomy
  • Tom Igoe for Electronics - [2]
  • OSHWA Guidelines by Nathan Seidle- [3]
  • Software - [4]
  • Repositories - [5]
  • Formats, Protocols, Standards - [6]

Documentation Jam Suggestions

Going Forward

  • See graphical representation of documentation requirements - [8]

Based on feedback:

  • Distinction should be made between Source Code (actual designs) and Metadata (dashboard) and Processes (fabrication) and Development Process.