11 3 / 2011

JavaScript Garden: Documenting The Quirky Parts

Good JavaScript documentation is extremely important, and through efforts like Promote JS, we have seen awareness of good documentation through sites like the Mozilla Dev Center increase, and sites like W3Schools, which provide old and often incorrect information, decrease through efforts like W3Fools.  

JavaScript Garden is another new source of good JavaScript documentation that just came out.  Rather than trying to be a guide for those unfamiliar with the language, JavaScript Garden is a guide to the “most quirky parts of the JavaScript programming language.”

JavaScript Garden is a growing collection of documentation about the most quirky parts of the JavaScript programming language. It gives advice to avoid common mistakes, subtle bugs, as well as performance issues and bad practices that non-expert JavaScript programmers may encounter on their endeavours into the depths of the language.

Put together by Ivo Wetzel and Zhang Yi Jiang, it covers common misconceptions and bugs related to objects, prototypes, functions, this, closures, the arguments object, scoping, equality and comparisons, typeof and instanceof, and much more.  The site is very nicely written and designed, and I recommend that you check it out!

It should be noted that some other sites with similar types of information include WTF JS, and John Resig’s tutorial on Learning Advanced JavaScript.  

It’s awesome to have great JavaScript documentation, and to have a community that takes the time to write it.  If you are interested in contributing, or you find errors, JS Garden is hosted on Github, so just file issues and send them pull requests to help make this resource even better.  Check out JavaScript Garden online here!