Project Documentation

Every project needs documentation. If you don't document it, you don't get to count it as a completed project!

Upland coins

Ideally projects would have:

You should be able to use this info to do the project again a year later, with minimal re-learning. Text files, markdown, HTML, sketches, etc. should be collected in one place, and ideally it's publicly accessible!

Before starting a project, take a few minutes to think about what kind of documentation the project deserves. Consider:

After the project, do a quick retrospective. Capture thoughts prompted by questions like these:

Not all projects deserve complete documentation. But all projects deserve some documentation. A photograph at the very least!