3 weken geleden heb ik een update gedaan van mijn Pxxl.js library, een libje waarmee je tekst kan ‘renderen’ naar pixel coördinaten om vervolgens leuke effecten mee te creëren. Het was niet eens een echte code update maar slechts een nieuwe githubpagina met uitleg en voorbeelden. Het grappige was dat ‘ie het best goed deed toen ik ’m op Reddit gooide: 72 upvotes + 45 github stars. En dat terwijl de code al 6 maanden niet meer veranderd was! :-) Zo blijkt maar weer dat een goede launch heel belangrijk is!

Daarom bij deze wat tips:

- Denk na over een goede beschrijving van je lib. Gebruik eenvoudige taal. De eerste zin moet kort en bondig zijn maar ook meteen het principe van de lib duidelijk maken. Geef ook aan waarom je deze lib/tool zou willen gebruiken of wat je er mee kan.

- Maak het de gebruiker zo makkelijk mogelijk om ermee aan de slag te gaan. Biedt een duidelijke download link en geef een eenvoudig stukje voorbeeld code. Als de gebruiker teveel moet nadenken over hoe deze lib gebruikt moet worden dan vergroot dat de kans alleen maar dat hij afhaakt.

- Laat zien wat je kan! Maak meerdere voorbeelden die verder gaan dan het ‘Hello World’ of ‘foo bar’ niveau. Demonstreer de kracht van de lib!

Sowieso was de hele release een clean-up actie:
- De API, voor zover die er is, is consistenter gemaakt, oa door goed gebruik van namespacing. 

- Voor ajax calls heb ik een minimalistisch cross-browser XHR object bijgevoegd ipv van jQuery afhankelijk te zijn. (Er zijn een hoop javascript developers met een hekel aan jQuery. Je kan het met ze oneens zijn maar begrijp dan wel dat er behoefte is aan libs die zonder jQuery kunnen.)

- De API is gedocumenteerd en evenals de voorbeelden netjes als code geformatteerd op de githubpagina.

Het meeste is eigenlijk samen te vatten als: bied het aan zoals je het zelf ook graag ziet. Simpel eigenlijk.. :-)

Ik hoop dat je wat aan deze tips hebt!

Remco Veldkamp

http://realstuffforabstractpeople.com
https://twitter.com/remcoder

De Pxxl library:
https://github.com/remcoder/Pxxl.js