Pretty well written piece about real documentation: http://stevelosh.com/blog/2013/09/teach-dont-tell/ Sven -- Sven Van Caekenberghe Proudly supporting Pharo http://pharo.org http://association.pharo.org http://consortium.pharo.org
I really liked it! thanks for the link :) On 2013-09-04, at 06:34, Sven Van Caekenberghe <sven@stfx.eu> wrote:
Pretty well written piece about real documentation:
http://stevelosh.com/blog/2013/09/teach-dont-tell/
Sven
-- Sven Van Caekenberghe Proudly supporting Pharo http://pharo.org http://association.pharo.org http://consortium.pharo.org
+1 Doru On Wed, Sep 4, 2013 at 2:13 PM, Camillo Bruni <camillobruni@gmail.com>wrote:
I really liked it! thanks for the link :)
On 2013-09-04, at 06:34, Sven Van Caekenberghe <sven@stfx.eu> wrote:
Pretty well written piece about real documentation:
http://stevelosh.com/blog/2013/09/teach-dont-tell/
Sven
-- Sven Van Caekenberghe Proudly supporting Pharo http://pharo.org http://association.pharo.org http://consortium.pharo.org
-- www.tudorgirba.com "Every thing has its own flow"
I have the impression that the Deep into Pharo book is going in that direction.
Pretty well written piece about real documentation:
http://stevelosh.com/blog/2013/09/teach-dont-tell/
Sven
-- Sven Van Caekenberghe Proudly supporting Pharo http://pharo.org http://association.pharo.org http://consortium.pharo.org
On 04 Sep 2013, at 21:54, Stéphane Ducasse <stephane.ducasse@inria.fr> wrote:
I have the impression that the Deep into Pharo book is going in that direction.
Rest assured that all the work that you and others are doing with regards to the different books is absolutely in the right direction ! Two/three years ago, the Pharo by Example and Seaside book were really important to me, heck they still are, especially the real paper versions. These did indeed 'teach'. So thank you and please continue. I know it is hard work, but is does make a real difference, I am sure to many people.
Pretty well written piece about real documentation:
http://stevelosh.com/blog/2013/09/teach-dont-tell/
Sven
-- Sven Van Caekenberghe Proudly supporting Pharo http://pharo.org http://association.pharo.org http://consortium.pharo.org
A big thank you from me as well , PBE definetly made possible to use Pharo. If I had to read pharo code to understand how to work I would be right back with python by now. Pharo can learn tons of things from the success of python , I am very glad to see that you guys put big priority on Documentation as python does. Youtube also has loads of squeak and pharo video tutorials. So thing actually are much better than I initially feared. The problems is that smaltlalkers tend to overestimate smalltalk and not document their code. They believe too much into "self documented" nonesense and this article hits the nail on the head concerning this problem. AFAIK the best way to code is by writting documentation at the same time. Unless you are the type of coder that tends to rewrite his library 10 times before releasing, which I seriously doubt. Python has been a huge success as a language because developer take documentation extremely seriously. I have not forget about documenting nativeboost, I will try to write a small article on my blog about nativeboost and the things I learned which may help you use it as part of the nativeboost documentation. If you have any request dont forget to ping me. -- View this message in context: http://forum.world.st/About-Documentation-Teach-Don-t-Tell-Steve-Losh-tp4706... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
On Sep 5, 2013, at 10:25 AM, kilon <thekilon@yahoo.co.uk> wrote:
A big thank you from me as well , PBE definetly made possible to use Pharo. If I had to read pharo code to understand how to work I would be right back with python by now.
thanks.
Pharo can learn tons of things from the success of python , I am very glad to see that you guys put big priority on Documentation as python does. Youtube also has loads of squeak and pharo video tutorials. So thing actually are much better than I initially feared.
The problems is that smaltlalkers tend to overestimate smalltalk and not document their code. They believe too much into "self documented" nonesense and this article hits the nail on the head concerning this problem. AFAIK the best way to code is by writting documentation at the same time. Unless you are the type of coder that tends to rewrite his library 10 times before releasing, which I seriously doubt. Python has been a huge success as a language because developer take documentation extremely seriously.
Yes I would love that Pharoers have the same spirit.
I have not forget about documenting nativeboost, I will try to write a small article on my blog about nativeboost and the things I learned which may help you use it as part of the nativeboost documentation. If you have any request dont forget to ping me.
We want the blog :) And also your feedback on the nativeBoost chapter.
-- View this message in context: http://forum.world.st/About-Documentation-Teach-Don-t-Tell-Steve-Losh-tp4706... Sent from the Pharo Smalltalk Developers mailing list archive at Nabble.com.
participants (5)
-
Camillo Bruni -
kilon -
Stéphane Ducasse -
Sven Van Caekenberghe -
Tudor Girba