What documentation should I request from my developer?

Question

Hi,

I am looking at commissioning a fairly straight forward restaurant directory and booking web app and I have had some quotes to use joomla and other OS CMS's as the base however I am thinking I like the idea of less clutter and more flexibility of a custom app. It will probably be cakePHP...

I want to make sure that I have the relevant docos / comments in code etc so that I can a)understand how my system works; and b) get another developer if this one does not work out.

What are the top things I should be asking for?

I am already thinking:

• comments in code
• database design / model
• class diagram
• main functional aspects
• versioning / subversion

What else would be good / useful / key?

thanks in advance...

Answer 1

• Comprehensive list of Use cases and
• List of modules, and which use cases they fulfill

The module descriptions should describe in detail which models/views/controllers they rely on or implement (assuming CakePHP). Points of interaction between modules must be well defined and documented.

What you have so far is good too.

Answer 2

As well as what @ford said:

• Tests associated with each module and/or use case
• Instructions of how to build, how to test, and how to deploy

Answer 3

• Detailed instructions on how to deploy the application
• Server environment requirements

Make sure you are able to install it on more than just one server without running into environment-specific problems.