[squeak-dev] Documentation Team

Michael Haupt mhaupt at gmail.com
Wed Aug 25 07:24:35 UTC 2010


Hi,

remembering that I had volunteered to contribute to documentation,
I've had a brief off-list exchange with Casey about this.
Interestingly, we both have in common that we like to have reasonably
sized work items that can be ticked off in predictable time frames.
Probably more people feel like this.

The questions you ask, and the solutions you propose make sense to me.

On Wed, Aug 25, 2010 at 8:20 AM, Hannes Hirzel <hannes.hirzel at gmail.com> wrote:
> 1) How do we include the help of people with maybe time as little as 1
> hour per month (but who have a huge Smalltalk knowhow, e.g. R.J.)
>
> 2) Where should we start?
>
> My answers
> 1) Have two persons who have commit access to the trunk who the other
> commiters trust who will commit changes. It is very motivating if I
> write a class comment for example and one day later it is in all my
> trunk images I update.

Why two? Class comments and documentation are trunk code, so trunk
developers should be able and entitled to contribute them. Everyone
interested can contribute via the inbox.

I think that the more complicated task is to get started (your
question 2). What needs to be documented? Who does it? How can this be
organised in an unobtrusive way?

What? - See below.
Who? - All of us.
How? - See below.

> 2a) I would say it should be customer driven. We should go to the
> beginners list and ask them what they want to know and try to work
> there.
> 2b) I did some querying about which classes need comments. More
> information available on request.

Mantis, Mantis, Mantis. Documentation issues should be considered
"bugs" (in the sense that they bug people). Requests for documentation
improvements / additions could be posted in a dedicated bug category.
I would expect particularly class comment issues to be about the size
that I alluded to above (reasonably sized, tickable-off in predictable
time - say, an hour a week, as you mentioned).

How about asking people to submit requests for documentation via
Mantis? Point people on the newbies list to that and have them ask for
improvement.

How about turning your "more information" into some Mantis issues right away?

Best,

Michael



More information about the Squeak-dev mailing list