Writing Technical Documentation

[tntcoder]

Hi,

I need to write some technical documentation for the software part of my comp sci dissertation. Could someone explain to me what this should include as im a bit lost and have heard varied opinions.

Am I correct in thinking it should include:
- Class Diagrams / Other evil UML designs
- Detailed descriptions of 'every single' object/function/method in the source code, covering how they work, interrelate and what their purpose in the system is

Is that along the right lines? anything else I should cover?

Thanks for any help,

Jack

 

[tntcoder]

Ok thanks guys, so are you saying rather than having a special technical doc as an appendix item, it should be broken down and covered in the appropriate sections throughout the main report?

 

[tntcoder]

Ok thanks very much