18
http://thingdoc.org Thursday, June 2, 2011

ThingDOC

Embed Size (px)

DESCRIPTION

Automatic generation of documentation

Citation preview

Page 1: ThingDOC

http://thingdoc.org

Thursday, June 2, 2011

Page 2: ThingDOC

PCBs

Printable parts

Lasercutparts

SimpleHow-tos

We are living in the internet of things

That means, we can share real Hardware online!

Thursday, June 2, 2011

Page 3: ThingDOC

We just don’t know how to organize it

...yet!http://thingiverse.com - messhttp://instructables.com - even more mess

...

Thursday, June 2, 2011

Page 4: ThingDOC

You can publish only completed projects. With hand tailored

documentation.Software has better solutions!

They can make documentation automagically!JavaDoc, PHPDoc, ...

Thursday, June 2, 2011

Page 5: ThingDOC

ThingDOC solves that!It can generate your HW project documentation.

Works on simple text comments.Printed parts, lasercut parts, ...

ThingDOC is being developed on PrusaMendel RepRap parts.

Thursday, June 2, 2011

Page 6: ThingDOC

Generator isn’t lazy!Normally you have to change documentationwith every update of the design! Thats hard

if documentation is long as small book and you update the design twice a day!

It causes:

1) Errors2) Out of date documentation3) Demotivates to update design often4) If you use wiki, its hard to find older documentation

Thursday, June 2, 2011

Page 7: ThingDOC

Forking is hard!

Thursday, June 2, 2011

Page 8: ThingDOC

With ThingDOC every thing in project has it’s own info about properties and relationships!

Thursday, June 2, 2011

Page 9: ThingDOC

So when you update or switch one file, you still can get full

featured documentation!Means:

Easy forking! Easy updating!

Thursday, June 2, 2011

Page 10: ThingDOC

Documentation is hyperlocal!

Informations about the object are embedded in the same file!

Thursday, June 2, 2011

Page 11: ThingDOC

What ThingDOC can do?

• Bill of materials

• Info about things

• Assembly instruction

• Structured data of your project

All in many formats! HTML, TXT, PDF, WIKI ...

Thursday, June 2, 2011

Page 12: ThingDOC

Interactive bill of materials

Thursday, June 2, 2011

Page 13: ThingDOC

Interactive bill of materials

Thursday, June 2, 2011

Page 14: ThingDOC

Things overview

Thursday, June 2, 2011

Page 15: ThingDOC

Assembly instructions!BEST!

Thursday, June 2, 2011

Page 16: ThingDOC

Works on mobile devices!

Thursday, June 2, 2011

Page 17: ThingDOC

From what it generates this awesomness?

Small comments like these!

Thursday, June 2, 2011

Page 18: ThingDOC

Thansks!

http://thingdoc.orgJosef Prusa (http://josefprusa.cz)

Pavol Rusnak

Thursday, June 2, 2011