documentation

Le DocSprint organisé samedi 9 février 2013 dans les locaux de Caravan ont rassemblé plus d’une dizaine de personnes. Malgré l’absence d’Eric Shepherd due à l’annulation de son vol, dont la présentation a été faite par visioconférence, l’évènement est un succès ! En effet, les participants étaient ravis de connaître les possibilités de MDN et d’engranger des connaissances en même temps qu’ils contribuaient à documenter le web.

Nous vous invitons à nous rejoindre samedi 9 février prochain pour participer à un sprint de documentation organisé pour tous les amoureux du Web! L’évènement se passe dans le très bel espace de Caravan, au 5333 avenue Casgrain, suite #1204 à Montréal.

In my experience, documentation is one of the weakest points of open source software. It’s often incomplete, unstructured and/or outdated. There are never enough examples. When examples are present, they often do not follow best practices for the sake of brevity. Another big issue is to distinguish between software versions, as it is seldom clear to what version(s) the current document applies. Digging through the source code should not be seen as a positive user experience.

Callbacks

In “How can I capture Disqus commenting activity in my own analytics tool?”, Disqus shows an example of the onNewComment callback. However, if we put loader.js through JS Beautifier, we get a list of seven callbacks:

This is a first post in a series: Dynamic Toolbar, JavaScript and jQuery, Dynamic Toolbar bugs.

The following is based on version 1.0.2.00 of the Dynamic Toolbar SDK.

pClojure is a truly amazing language and still a very young one. There is already a substantial quantity of documentation available for Clojure and some of its libraries. Yet, when talking about documentation, some is not enough. Sure, there's the REPL with all its bells and whistles, but sometimes I prefer to navigate through a well formatted API document using a browser.