on documentation

People often debate on reasons of PHP’s success and “not so big success” of it’s more powerful competitors. My belief is, that one of the major parts of PHP’s win was it’s manual. All of the competitors had basic API documentation, but they didn’t have:

  • syntax-highlighted examples for the majority of functions
  • user-contributed comments

It’s actually getting better now (see documentation on Ruby’s CGI module, for example). But no-one is close enough.

One of the main concerns of the language core-team should be documentation. Better the docs are, more people will be comfortable to start using it for solving their problems.

If I have several weeks for digging into sources, I will probably chose the language which I like syntactically. But if the timeframe if small, I would definitely prefer the one which has better docs. Guess which situation tends to happen more often.

Something to think about:

Share and Enjoy:
  • Digg
  • del.icio.us
  • Facebook
  • DZone
  • FriendFeed
  • Reddit
  • Tumblr
  • Twitter

View Commentson documentation

  • Язык он как человек – должен быть хорош многогранно. Быть с одной стороны сильным и удобным с функциональной стороны, быстрым и расширяемым с другой стороны, лёгким и красивым с третьей.. Ну и всевозможные психологические аспекты тоже влияют – “как яхту назовёшь, так она и поплывёт” (Христофор Бонифартьевич Врунгель)

  • jk

    Seriously. I've been hacking old VBA lately, and the online help is almost useless. It's not like Access is crap – it's actually fun in a lot of ways, but the help system is not good, and the examples are not useful.

Leave a Reply

 

 

 

You can use these HTML tags

<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

blog comments powered by Disqus