Guidelines for Writing a Tutorial

Submitted by admin on December 13, 2006 - 8:01pm.

Number One Rule:

Document your robot so that any reasonable person (open to interpretation) can build a copy of their own.

 

What this is not:

This is not a blog for your robot. Dont say things such as 'today I got parts in for my robot' or 'Dec 12, 2007: The treads on my tank were assembled.' Remember, you are writing to teach others how to make your robot. As such, it is best to start writing a tutorial towards completing your robot, and not in the early stages.

 

Other guidelines:

Include source code of your robot. Dont forget to mention the platform your code should run on (ex. PIC16F877, or Java for PC, etc.). Do your best to comment your code. Please put all your source code in a zip file.

Include CAD files (zipped), design drawings, and/or images of individual parts of your robot. List the parts you bought. Dimensions too. Images of your robot at several angles, and even the assembly process, is encouraged.

For electronics, show schematics and give descriptions of how the circuit works. List components used. 

Talk about tips on building your robot, mistakes to avoid, or possible additions that could/should be added to make it better.

Grammar/spell check! Make sure all links work.

 

Optional:

It is your creation, take credit for it! What you document is solely your property (open source rules).

Include information such as how long it took to make your robot, how much it cost, difficulty for someone of your experience, etc.

 

Example:

My sumo robot tutorial is a good example. Writing a tutorial is somewhat a time consuming process, as I typically spend between 4 to 15 hours on each one. Remember, the better you write it, the more people will link back to your page.