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
Liked this post? Follow me on twitter:@jimi_dini.

  • http://kurapov.name Артём Курапов

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

  • http://riceball.com/d 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.

A sample text widget

Etiam pulvinar consectetur dolor sed malesuada. Ut convallis euismod dolor nec pretium. Nunc ut tristique massa.

Nam sodales mi vitae dolor ullamcorper et vulputate enim accumsan. Morbi orci magna,tincidunt vitae molestie nec,molestie at mi. Nulla nulla lorem,suscipit in posuere in,interdum non magna.