You are currently offline, so some features of this site may not work fully.

Your browser doesn’t support some of the latest CSS features used to build this site.

Read more about my usage of new CSS features.

Why documentation?

Those who know me know that I love well written and well documented code. They also know that I ❤️ automating repetitive, menial tasks in order to free mine and my team’s time up for doing what we do best - the coding!

One of the first things I do on a project is to set up these automated tasks and set standards in place for the whole team to document JavaScript so that we can create easily readable, quality code that any one of the team can contribute to.

Standards and reporting

Your team should be writing to such a standard that anyone can pick up a task, look at the code and work with it straight away.

I use gulp-jsdoc3 to produce JavaScript documentation and gulp-plato (and moving over to using Plato directly soon) to produce a JavaScript complexity report. Having these docs visible on project teams helps me and other developers see and catch any errors as early as possible.

The Docs

So without further ado, feel free to inspect the automatically produced JavaScript documentation and complexity reports for my code.

Take a look at the gulp tasks for documentation buiding.