Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

In my personal opinion, I'd like to present a fair comparison with another similar framework called KnockoutJS.

I challenge anyone on Hackernews to show me better documentation than this one:

http://learn.knockoutjs.com

Notice how things are explained so well as if they were explained to a child, this is how you should document, IMO.

Also, RP Neimeyer, the creator (EDIT: Committer) of this framework, has dedicated a significant portion of his life to helping out new comers to the framework, by having a separate website (http://knockmeout.net) (apart from the one above) to train and help people understand KnockoutJS. This is the kind of effort every developer should put in, IMO, if they want people to get off the ground with their framework.



I didn't like it. Too much visual overhead. I didn't know where to look.

Also a few things went wrong (don't know what). I was clicking around in code window when the tutorial guide on the left disappeared, then I tried refreshing and everything went blank. So I clicked on url in the navbar and pressed enter. Now the page loaded. But everything was blank inside the boxes.

OSX 10.8.3 with chrome.

Ohh, I found out what went wrong. I tried scrolling in the code window and the browser went back to the last page which it thinks is: http://learn.knockoutjs.com/ and that makes the tutorial disappear.


KO has great how-tos and examples, no doubt, but I would never put it forward as an example of great documentation, for the single and very large fact that it's utterly lacking in API reference documentation. Where, for instance, can I find a list of the ko.utils.* namespace? How do I release bindings when I dispose of a view? The existing documentation gives me nothing. I'm left googling blogs and stackoverflow answers.

Compare that to http://docs.angularjs.org/api .

Real API documentation would do a lot to dispel the myth that KO is only for small to medium projects.


RP Niemeyer did not create Knockout. That was Steve Sanderson. Niemeyer has make but 9 commits to the Knockout codebase¹.

Knockout's tutorials are great. However, the rest of the documentation takes the form of other, slightly less helpful tutorials. The only API documentation is reading the code.

¹ https://github.com/SteveSanderson/knockout/commits?author=rn...


Oh sorry, I didn't know that! But I see only him answering SO questions and writing blog posts 99% of the time, hence the assumption..


Agreed - customer service at its finest and no doubt something we should all aspire to if we want to increase adoption.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: