{"id":27724,"date":"2016-10-27T17:37:07","date_gmt":"2016-10-27T21:37:07","guid":{"rendered":"http:\/\/www.shapeways.com\/blog\/?p=27724"},"modified":"2016-10-28T16:54:46","modified_gmt":"2016-10-28T20:54:46","slug":"documenting-open-source-hardware-with-shapeways","status":"publish","type":"post","link":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways","title":{"rendered":"Documenting Open Source Hardware with Shapeways"},"content":{"rendered":"

This week we held a community event<\/a> that was all about documenting open source hardware.\u00a0 The event was part of Open Source Hardware Month<\/a>, a monthlong celebration organized by the Open Source Hardware Association<\/a>. Documentation is a critical \u2014\u00a0although easy to overlook \u2014\u00a0component of open source hardware. It can be very hard for users to build on or modify even the most open piece of hardware without clear documentation explaining how it works.<\/p>\n

\"giphy\"\"giphy-1\"<\/p>\n

The event itself was held at the great new(ish)\u00a0FatCat Fab Lab<\/a> in Manhattan (which is also the home of a hot shot game \u2014\u00a0gifs above \u2014\u00a0that was the talk of the NYC Maker Faire), and drew creators from all across the city.<\/p>\n

The opening discussion was about the open source hardware certification program<\/a> that was recently announced by the Open Source Hardware Association. Part of the goal of the documentation days and nights<\/a> behind held around the world is to make it easier for people to successfully apply for the free certification.<\/p>\n

\"Shapeways

Zack showing off his hand computer controller<\/p><\/div>\n

The heart of the event was a discussion by Phillip Torrone and Limor Fried of Adafruit Industries<\/a>. Adafruit is the home of hundreds of thoroughly documented open source hardware products<\/a>, and they discussed the evolution of that documentation from blog to wiki to custom site as well as some practical tips for designing better documentation (take a picture of every action!).<\/p>\n

After the discussion there was an opportunity for everyone to discuss projects and their best practices for documenting projects. Documenting can be idiosyncratic to specific projects, so ultimately the best advice may be to jump in with whatever is comfortable and start documenting. If you wait for the perfect documentation platform you may end up not documenting anything at all!<\/p>\n

\"Shapeways

Limor from Adafruit, Michael From Shapeways, and Peter From Fat Cat Fab Lab<\/p><\/div>\n

By the end, the event served as a great reminder that the fantastic items you might find in a Shapeways shop are part of a collaborative and iterative design process. The Shapeways community loves to create together, and the night was an opportunity to reflect on the power of simple documentation in that collaborative process.<\/p>\n","protected":false},"excerpt":{"rendered":"

This week we held a community event that was all about documenting open source hardware.\u00a0 The event was part of…<\/p>\n","protected":false},"author":73,"featured_media":27776,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[478],"tags":[839,584,1231,1543,1392],"class_list":["post-27724","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-community","tag-3d-printing-community","tag-maker","tag-maker-space","tag-open-source-hardware","tag-tips"],"thumbnail":"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173-625x468.jpg","yoast_head":"\nDocumenting Open Source Hardware with Shapeways - Shapeways Blog<\/title>\n<meta name=\"description\" content=\"This week we held a community event that was all about documenting open source hardware.\u00a0 The event was part of Open Source Hardware Month, a monthlong\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Michael Weinberg\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways\"},\"author\":{\"name\":\"Michael Weinberg\",\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/person\/9e9a6a0945ba18a78ec44fcb66169360\"},\"headline\":\"Documenting Open Source Hardware with Shapeways\",\"datePublished\":\"2016-10-27T21:37:07+00:00\",\"dateModified\":\"2016-10-28T20:54:46+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways\"},\"wordCount\":383,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173.jpg\",\"keywords\":[\"3D printing community\",\"maker\",\"maker space\",\"open source hardware\",\"tips\"],\"articleSection\":[\"The Community\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways\",\"url\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways\",\"name\":\"Documenting Open Source Hardware with Shapeways - Shapeways Blog\",\"isPartOf\":{\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173.jpg\",\"datePublished\":\"2016-10-27T21:37:07+00:00\",\"dateModified\":\"2016-10-28T20:54:46+00:00\",\"description\":\"This week we held a community event that was all about documenting open source hardware.\u00a0 The event was part of Open Source Hardware Month, a monthlong\",\"breadcrumb\":{\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#primaryimage\",\"url\":\"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173.jpg\",\"contentUrl\":\"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173.jpg\",\"width\":800,\"height\":600},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/prodshapeblog.wpenginepowered.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documenting Open Source Hardware with Shapeways\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#website\",\"url\":\"https:\/\/prodshapeblog.wpenginepowered.com\/\",\"name\":\"Shapeways Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/prodshapeblog.wpenginepowered.com\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#organization\",\"name\":\"Shapeways Blog\",\"url\":\"https:\/\/prodshapeblog.wpenginepowered.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2019\/05\/shapeways-blog.png\",\"contentUrl\":\"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2019\/05\/shapeways-blog.png\",\"width\":943,\"height\":121,\"caption\":\"Shapeways Blog\"},\"image\":{\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"http:\/\/facebook.com\/shapeways\",\"https:\/\/x.com\/shapeways\",\"http:\/\/instagram.com\/shapeways\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/person\/9e9a6a0945ba18a78ec44fcb66169360\",\"name\":\"Michael Weinberg\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/bddee74f0460eed9142c3391488f5ed2d0a891214dc51cf9cb6ebfbbf99c82ce?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/bddee74f0460eed9142c3391488f5ed2d0a891214dc51cf9cb6ebfbbf99c82ce?s=96&d=mm&r=g\",\"caption\":\"Michael Weinberg\"},\"url\":\"https:\/\/www.shapeways.com\/blog\/author\/michael-weinberg\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Documenting Open Source Hardware with Shapeways - Shapeways Blog","description":"This week we held a community event that was all about documenting open source hardware.\u00a0 The event was part of Open Source Hardware Month, a monthlong","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways","twitter_misc":{"Written by":"Michael Weinberg","Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#article","isPartOf":{"@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways"},"author":{"name":"Michael Weinberg","@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/person\/9e9a6a0945ba18a78ec44fcb66169360"},"headline":"Documenting Open Source Hardware with Shapeways","datePublished":"2016-10-27T21:37:07+00:00","dateModified":"2016-10-28T20:54:46+00:00","mainEntityOfPage":{"@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways"},"wordCount":383,"commentCount":0,"publisher":{"@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#organization"},"image":{"@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#primaryimage"},"thumbnailUrl":"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173.jpg","keywords":["3D printing community","maker","maker space","open source hardware","tips"],"articleSection":["The Community"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways","url":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways","name":"Documenting Open Source Hardware with Shapeways - Shapeways Blog","isPartOf":{"@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#primaryimage"},"image":{"@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#primaryimage"},"thumbnailUrl":"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173.jpg","datePublished":"2016-10-27T21:37:07+00:00","dateModified":"2016-10-28T20:54:46+00:00","description":"This week we held a community event that was all about documenting open source hardware.\u00a0 The event was part of Open Source Hardware Month, a monthlong","breadcrumb":{"@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#primaryimage","url":"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173.jpg","contentUrl":"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2016\/10\/IMG_6173.jpg","width":800,"height":600},{"@type":"BreadcrumbList","@id":"https:\/\/www.shapeways.com\/blog\/documenting-open-source-hardware-with-shapeways#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/prodshapeblog.wpenginepowered.com\/"},{"@type":"ListItem","position":2,"name":"Documenting Open Source Hardware with Shapeways"}]},{"@type":"WebSite","@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#website","url":"https:\/\/prodshapeblog.wpenginepowered.com\/","name":"Shapeways Blog","description":"","publisher":{"@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/prodshapeblog.wpenginepowered.com\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#organization","name":"Shapeways Blog","url":"https:\/\/prodshapeblog.wpenginepowered.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/logo\/image\/","url":"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2019\/05\/shapeways-blog.png","contentUrl":"https:\/\/www.shapeways.com\/blog\/wp-content\/uploads\/2019\/05\/shapeways-blog.png","width":943,"height":121,"caption":"Shapeways Blog"},"image":{"@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/logo\/image\/"},"sameAs":["http:\/\/facebook.com\/shapeways","https:\/\/x.com\/shapeways","http:\/\/instagram.com\/shapeways"]},{"@type":"Person","@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/person\/9e9a6a0945ba18a78ec44fcb66169360","name":"Michael Weinberg","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/prodshapeblog.wpenginepowered.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/bddee74f0460eed9142c3391488f5ed2d0a891214dc51cf9cb6ebfbbf99c82ce?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/bddee74f0460eed9142c3391488f5ed2d0a891214dc51cf9cb6ebfbbf99c82ce?s=96&d=mm&r=g","caption":"Michael Weinberg"},"url":"https:\/\/www.shapeways.com\/blog\/author\/michael-weinberg"}]}},"_links":{"self":[{"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/posts\/27724","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/users\/73"}],"replies":[{"embeddable":true,"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/comments?post=27724"}],"version-history":[{"count":0,"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/posts\/27724\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/media\/27776"}],"wp:attachment":[{"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/media?parent=27724"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/categories?post=27724"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.shapeways.com\/blog\/wp-json\/wp\/v2\/tags?post=27724"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}