Showing posts with label Documentation. Show all posts
Showing posts with label Documentation. Show all posts

Monday, November 3, 2014

Design & Architecture Documents style for a software project



Recently, while browsing a catalogue of RC cars (from Kyosho), I stumbled upon the following picture.




This picture is not from assembly instruction booklet but from a product catalogue.

Now have a look at the two famous brands that promote DIY – Lego and Ikea.

Here is an instruction set for a very simple Lego toy.


And here is one page from Ikea’s instruction booklet: 



Which picture provides most information in the easiest way to assemble the item under construction? Focus should be on placement of parts before assembly and during assembly.
What is your design and architecture documentation style – Lego, Ikea, Kyosho or something else?


Thursday, May 3, 2012

Documentation for Support Team

Recently, my dev team was handing over a project to support team. While handing over the project, most of the support managers asked for documentation which should assume support engineers as dumb. A support engineer should be able to do various support tasks after following the documentation in verbatim. Yes I mean verbatim (even clicks and screen shots to create do mundane tasks).

Does support teams are made of such dumb persons? If not then does it is worthwhile to make such documents?