Project Documentation Programmer Guide

[article] [edit page] [discussion] [history]

From Humanitarian-FOSS Project Development Site

An important piece of documentation for your final project is the Programmer's Guide. This document should provide documentation necessary and sufficient to allow another programmer to take over your project with a minimum of time and effort.

We don't have a template that you can follow for this documentation. Instead, here is a list of links to various programming guides. Choose one that appeals to you and follow its format. Having a guide that can be viewed in a browser is an attractive feature. Of course, your guides needn't be as long as these example.


If you find a guide that you particularly like, share it by including a link to it here:

Personal tools