Documentation

A critical deliverable of any software project is documentation. This is particularly the case when working on fixed term contracts as once the contract is over the client must understand the code in order to get any value from the work done under the contract.

Three examples of documentation I've produced (linked elsewhere on the site, but reproduced here for convenience) are:

• An example of code documentation in the form of JavaDoc for an API produced as on of the deliverables of a recent contract.
• A full developer's manual for the same API in PDF format.
• This was accompanied at a developers' workshop by a selection of exercises, also in PDF format. The exercises really only make sense when followed with the virtual machine image created for the workshop, but this should give a sense of the kind of documentation and other supporting material I can produce.