Andre Parmeggiani
2005-Sep-16 22:46 UTC
Documentation [was RTFM, Money-making opportunity, etc.]
Hi All, I''d like to contribute to the documentation thread as in my view it''s fundamental to developers'' day2day. I''ve been using php and mysql for long and i can say that i''m very confortable using their documentation. I''m using RoR now and even contributing with some snippets when possible. I know they''re different projects and in different stages. My intention is not to generate flames, but why not to copy something that works well (and can be copyed) ? Compare this doc starting pages: http://www.php.net/docs.php http://dev.mysql.com/doc/ http://www.ruby-doc.org/ http://documentation.rubyonrails.com/ And now http://www.php.net/manual/en/ http://dev.mysql.com/doc/mysql/en/index.html http://www.ruby-doc.org/core/ http://api.rubyonrails.com/ The main features i like in the php/mysql documentation: 1) a start page with options for laguage/format 2) all pieces centralized in a single doc well structured 3) as plenty of examples as possilbe. 4) open to insertion of new examples and comments 5) searchable Does that make sense ? I think i''m nor ready to structure such document, but for sure to contribute to fill it as much as i use it. Regards, Andre _______________________________________________ Rails mailing list Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org http://lists.rubyonrails.org/mailman/listinfo/rails