Un-Documented Code

admin's picture

Write documentation for any code you write, and for how your system is set up.

Why?
  • This will save you a lot of time when you come back to your code later on, or when someone else takes over maintaining it
How?
  • Add comments to your code clearly explaining what each function does
  • Include a Read Me file with each module you write
  • Write up how your site is structured

We'll do another tutorial in future on how to thouroughly document your project and the tools available: