Hello Otto Builders
Many of you have been familiar with Wikifactory or how we documented Otto DIY projects; it has proven to be a challenge and taunting task that got over our hands (since now there are more than 100 remixes of Otto) even after i dedicated soo much time to them it seems was not enough, people still struggle somehow to find files etc... My conclusion from all these years of experience with Open Source Hardware, is that simple, well explained, somehow fun and complete files always wins.
Here is a general "template" that you can copy and paste or use as reference, it is more of a checklist to make sure your robots are replicable from others. Empathy of how people will read and understand your project is the key and constant improvement (like this template itself), you can not abandon your project! keep it updated and use the internet in your advantage.
🔧 Title of project with short description
📷 Good Photos (of everything and all angles, especially of the process and the final look)
📹 Showcase video (maybe the best is to see the actual video working like many of you do)
✔️% of completeness (it helps to know if it is still work in progress)
✏️ Version # (keep track of changes)
⏱️ Time to build/assemble (how much time should I invest on this?)
📝 BOM / List of Parts and tools (Super important where most projects fail ask me why)
📄 Instruction manual (this could be a PDF or photos or video or all of them! what you miss here people will ask for but also would mean frustration for the users, sometimes a video takes less time to create than to type a long text with every step in detail and still many people wouldn't understand or be able to read)
⚡ Wiring (could be fritzing a pdf or a picture made in inkscape or even paint)
💻 Blockly code or ♾️ Source code/libraries/examples (could be both)
🏭 Fabrication technology with settings (some projects use one or none or all of them)
- 🧊3D printing must have the .STL files but also provide the CAD source and STEP
- ✂️laser cut .dxf but good to have the vector source .ai or .svg
- There are plenty more digital fabrication technologies but with the same principle source files + machine files + settings
📛 Naming the files is super important! this apply for any digital file even photos i follow this general structure, you will see how relevant this is once you folder is a mess.
Name of project + category + version#
(you can ignore this at start but is important for stablishing your intentions, Creative Commons Attribution-ShareAlike CC-BY-SA i think is the best (in this forum no need but if you wanna post out there in the internet or if you want to be an international certified open source project this is a must)
___________________________________________ End template
Now I want to know your opinion of this template since this might be the replacement of Wikifactory if we handle it well, for our full projects we could create a dedicated topic here or a webpage/blog posts for them.
Did i miss something?
Of course I don't expect you to have all your projects fully documented with all this points finished, specially the first posts that are to showcase only but this could be a mid term reference objective for you, so that the best projects don't perish or get forgotten, leave a legacy!