Manual-examples

Here are two examples of previous technical manuals. Use them as a guide if you have no idea what a particular section is asking for. However, don't plagiarise or anything, both because (a) it's wrong and (b) I highly doubt we are the only group with past examples, so it will be a bit suspicious if everybody writes the same thing.

[|Team Cinder Technical Manual.pdf] (Death Star tracker)

[|Technical Manual FOCUS.doc] (Talking scales)

code Hey everyone,

Hope you are enjoying the first day of the break. Sadly we can't quite enjoy it yet because we have our enormous technical manual to write by Tuesday. Somebody (I think Alex) has set it up on the wiki ( http://mtrx3700cassia.wikispaces.com/manual) and I think this is a good idea as we can all contribute. However, I don't know what happens if two people try to edit simultaneously, so if you are writing any long contributions, it may be best to do them in a Word document for safety and then paste them in.

We also need to allocate some primary areas of responsibility to do the bulk of the work. The manual is divided into modules, not software functions, although there is also a section where we have to describe software architecture. I have suggested a breakdown below, but it may need a bit of revising. There is plenty of general text to write in the manual too so please contribute to that.

I'm not sure how busy everyone is over the weekend, but it would be great if you can get your parts allocated here done by *MONDAY afternoon *at the latest, so that we can go through on Tuesday and add anything that's left over. (So please try to be available on Tuesday too! Sorry to be demanding but this is a 100+ page document and we're going to need everyone's consistent help to get it done in only a couple of days.)


 * Hardware and software*

Keypad - Ryan LCD - Michelle Serial transmit - Michael Serial receive - Kit A/D - Michelle Text to speech - Kit


 * Software only*

Calibrate - Alex & Duncan Calculate mass - Duncan & Michael Calculate variance - Michael Tare - Michael (this function is like 2 lines long) Count - Alex


 * Other parts of report

System performance as delivered - Ryan
 * Design of user interface menus - Lis


 * Other tasks*

Document software with Doxygen - Everyone (do we have a final version of all the code that we can upload to the wiki?)

If you have any suggestions or changes to this, send them through.

Cheers, Michael code