Author Topic: Writing a documenation, any advice?  (Read 1810 times)

0 Members and 1 Guest are viewing this topic.

Offline Electric flowerTopic starter

  • Regular Contributor
  • *
  • Posts: 83
  • Country: hr
Writing a documenation, any advice?
« on: May 14, 2014, 04:37:51 pm »
I need to write a documentation for school project and i was wondering what should be put in it?

Thing i designed and built is an acustic switch.


All work and no play makes Jack a dull boy.
All play and no work makes Jack a mere toy.
 

Offline Zillolo

  • Contributor
  • Posts: 12
Re: Writing a documenation, any advice?
« Reply #1 on: May 14, 2014, 06:21:19 pm »
Maybe this can help you:

http://en.wikipedia.org/wiki/IMRAD
 

Offline geo_leeman

  • Regular Contributor
  • *
  • Posts: 137
  • Country: us
    • Professional Website/Blog
Re: Writing a documenation, any advice?
« Reply #2 on: May 15, 2014, 01:56:07 pm »
I highly recommend writing in LaTeX. 

http://www.maths.tcd.ie/~dwilkins/LaTeXPrimer/
 

Offline abaxas

  • Regular Contributor
  • *
  • Posts: 131
Re: Writing a documenation, any advice?
« Reply #3 on: May 15, 2014, 02:31:28 pm »
First question should always be...

Who is the target audience?

 

Online tszaboo

  • Super Contributor
  • ***
  • Posts: 7377
  • Country: nl
  • Current job: ATEX product design
Re: Writing a documenation, any advice?
« Reply #4 on: May 15, 2014, 03:49:08 pm »
You can start it by writing an about half/one page (A/4 or equivalent) so called Abstract, explaining what you actually did, why you did it, and what problems you encountered. Then copy it here, after that maybe we can help. It will go into the documentation.
 


Share me

Digg  Facebook  SlashDot  Delicious  Technorati  Twitter  Google  Yahoo
Smf