Documentation Guidelines

These pages represent good practice guidelines for and aims to cover all the main areas of software development. The purpose of this is to ensure that what is produced does not require the author to explain things but rather that the documentation includes enough detail that a renal registry developer can understand and progress projects developed by others. 

As always with documentation what is obvious to one person may not be for someone else so it is always important to ensure documentation is tested by users who don't necessarily have a priori knowledge of the subject. When gaps are found in the documentation by a user they should always add the extra information required.