Documentation Taxonomy - Refactoring: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
=Existing Best Practices & Taxonomies= | =Existing Best Practices & Taxonomies= | ||
*OSHWA Best Practices for Open Source Hardware by David Mellis - [https://docs.google.com/document/d/1CiL9nd0xPOGRkHcNnOTZdHG-niAHteOm74f9PmAHdLg/edit] | *OSHWA Best Practices for Open Source Hardware by David Mellis - [https://docs.google.com/document/d/1CiL9nd0xPOGRkHcNnOTZdHG-niAHteOm74f9PmAHdLg/edit] | ||
*OSE Taxonomy - [[OSHW Documentation Taxonomy]] | |||
*Tom Igoe for Electronics - [https://docs.google.com/spreadsheet/ccc?key=0AiEMWaSr2APTdGdFY1lDRzN6TENQNHVOb3MxV1JER3c#gid=0] | *Tom Igoe for Electronics - [https://docs.google.com/spreadsheet/ccc?key=0AiEMWaSr2APTdGdFY1lDRzN6TENQNHVOb3MxV1JER3c#gid=0] | ||
*OSHWA Guidelines by Nathan Seidle- [http://www.oshwa.org/sharing-best-practices/] | *OSHWA Guidelines by Nathan Seidle- [http://www.oshwa.org/sharing-best-practices/] | ||
*Software - [https://docs.google.com/document/d/1sjZKT4l7nNgODX53wIJYFcMJtn0Jj80C61ZwyGx8UCI/edit#] | |||
*Repositories - [https://docs.google.com/document/d/1sjZKT4l7nNgODX53wIJYFcMJtn0Jj80C61ZwyGx8UCI/edit#] | |||
*Formats, Protocols, Standards - [https://docs.google.com/document/d/1sjZKT4l7nNgODX53wIJYFcMJtn0Jj80C61ZwyGx8UCI/edit#] | |||
=[[Documentation Jam]] Suggestions= | =[[Documentation Jam]] Suggestions= | ||
* | *[[David Mellis Suggestion]] | ||
*Guidelines for participation - [https://docs.google.com/document/d/1AFqhx8CxsMl7kg5pgAx8GX4n2OYU1d2Md3FGtEbZ-sc/edit] | |||
=Going Forward= | |||
*See graphical representation of documentation requirements - [https://docs.google.com/drawings/d/1HJa6yWnQvXVHd72nemBcIkB67-w5RZBMJQlIeyc87M4/edit] | |||
*Add Development to the Documentation - some of the Dashboard is related to development already | |||
Based on feedback: | |||
*Distinction should be made between Source Code (actual designs) and Metadata (dashboard) and Processes (fabrication) and Development Process. | |||
Latest revision as of 21:00, 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
- David Mellis Suggestion
- Guidelines for participation - [7]
Going Forward
- See graphical representation of documentation requirements - [8]
- Add Development to the Documentation - some of the Dashboard is related to development already
Based on feedback:
- Distinction should be made between Source Code (actual designs) and Metadata (dashboard) and Processes (fabrication) and Development Process.