This website recently got a major rebuild; if you're missing something, let Lorna know.

9 Steps to PHP Documentation Heaven



  1. Download PHPDocumentor and uncompress it into a directory inside your web root.
  2. Access the web interface by going to phpdoc.php in the newly extracted directory
  3. Enter the directory you would like to document
  4. Enter the directory the output should appear in (this needs to exist and be writable by the user your web server runs as)
  5. Choose a template! My favourite is the HandS one, but there are others and you can create your own later on
  6. Press the create button
  7. If your code wasn’t already documented correctly then there might not be a lot to see at this point. Go to the PHPDocumentor tutorial to find out how your commented code can become shiny documentation you can use [STRIKEOUT:to blind your manager with science] to empower knowledge-sharing within your team
  8. Regenerate the documentation
  9. Get the rest of your team to comment their code correctly

Now repeat steps 8 and 9 many times until you have beautiful documentation.


In: php