[Tutor] Documentation concerns.

Magnus Lyckå magnus@thinkware.se
Fri May 23 16:30:02 2003


At 01:18 2003-05-23 -0400, Paul Tremblay wrote:
>Contributing documentation is perhaps a way we non-programmers (at
>least non-skilled programmers) can really help out.

I completely agree. In fact, it's an area where it's sometimes
just a disadvantage to be a good programmer. The best documents
are probably a result of cooperation between the really good and
the newbies, because as a programmer with lots of routine, more
or less everything is obvious (which makes documentation less than
essential) but for the newbie it's not trivial to be completely
correct (considering possible exceptions etc).

As far as I understand, it takes some effort to learn the tools
used to create python documentation, but I think those who work
with documentation would be very happy if a few of us here in the
tutor mailing list would start submitting clarifying patches to
the docs.


--
Magnus Lycka (It's really Lyckå), magnus@thinkware.se
Thinkware AB, Sweden, www.thinkware.se
I code Python ~ The shortest path from thought to working program