[squeak-dev] Proposal: Project Pink Book

Michael Haupt mhaupt at gmail.com
Sun May 2 12:03:58 UTC 2010


Hi,

sorry for being late, but week-ends are for relaxing sometimes. :-)


Regarding spell checking and the upcoming documentation frenzy, I
don't think poor spelling will be that much of a problem for two
reasons. First, I don't believe that so many people speak and write
such a poor English that it deserves utmost attention. Second, if the
documentation process allows for trunk-like quick pushes to the
repository, glitches and unclear formulations can be quickly mended by
anyone interested in doing so.

Given that the number of people who are actually willing to commit to
the documentation thingy can be expected to be low (yup, call me a
pessimist), we can nevertheless expect high interest in good
documentation in those who contribute. So - let's not worry about the
spelling issues right now.

In a nutshell, I think that getting a possibly external spell checker
to work in Squeak may be an interesting project, but it's not really
of immediate help with regard to the documentation plans. (If the
above observations are correct.)


Regarding quality of documentation (more precisely: of class
comments), I would expect the best quality from those who know most
about the classes in question. But will those people write the most?
Not necessarily. So how about this: someone writes the documentation
for a class and commits it, and the next thing is to ask those three
people who had the most commits to that very class for their opinion
on the documentation.


Best,

Michael



More information about the Squeak-dev mailing list