<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=Content-Type content="text/html; charset=iso-8859-1">
<META content="MSHTML 6.00.2800.1126" name=GENERATOR>
<STYLE></STYLE>
</HEAD>
<BODY bgColor=#ffffff>
<DIV><FONT size=2>Hi, Chris!</FONT></DIV>
<DIV><FONT size=2></FONT> </DIV>
<DIV><FONT size=2>A Documentation Swiki makes sense, but I'd prefer to see the
"Squibes" remain on the main list, both to minimize cross-posting and to ensure
everyone's kept up to date both on development and on documentation.
Perhaps a [DOC] tag could flag particularly "documentation-oriented" messages,
but there's great value in keeping everyone in close communication.</FONT></DIV>
<DIV><FONT size=2></FONT> </DIV>
<DIV><FONT size=2>That's my vote. (-:</FONT></DIV>
<DIV><FONT size=2></FONT> </DIV>
<DIV><FONT size=2>Gary Fisher</FONT></DIV>
<DIV><FONT size=2></FONT> </DIV>
<BLOCKQUOTE
style="PADDING-RIGHT: 0px; PADDING-LEFT: 5px; MARGIN-LEFT: 5px; BORDER-LEFT: #000000 2px solid; MARGIN-RIGHT: 0px">
<DIV style="FONT: 10pt arial">----- Original Message ----- </DIV>
<DIV
style="BACKGROUND: #e4e4e4; FONT: 10pt arial; font-color: black"><B>From:</B>
<A title=christian.burkert@s2000.tu-chemnitz.de
href="mailto:christian.burkert@s2000.tu-chemnitz.de">Chris Burkert</A> </DIV>
<DIV style="FONT: 10pt arial"><B>To:</B> <A
title=squeak-dev@lists.squeakfoundation.org
href="mailto:squeak-dev@lists.squeakfoundation.org">The general-purpose Squeak
developers list</A> </DIV>
<DIV style="FONT: 10pt arial"><B>Sent:</B> Wednesday, February 05, 2003 8:24
AM</DIV>
<DIV style="FONT: 10pt arial"><B>Subject:</B> Documentation [was: Morphic
tutorial]</DIV>
<DIV><BR></DIV>Hi List<BR><BR>I think there are some people (I'll call them
writers), who could write <BR>some documentation, even if they are newbies.
For example I would write <BR>down some things about squeak if I had some guys
(I'll call them <BR>leaders) who could tell me where to start and they would
point out the <BR>main ideas.<BR><BR>So here are my suggestions:<BR><BR>- let
us create a seperate mailinglist for documentation<BR> This list
should be read by those leaders and by the writers.<BR> You may
say there aren't much. Maybe ... but I'm one of those!<BR> Let's
turn the enthusiasm of newbies into good documentation<BR> work.
Let's integrate newbies. Give them the opportunity to<BR> explore
a little piece of squeak. This way newbies aren't<BR> overcharged
and can look inside the world of squeak. On the<BR> other hand the
leaders can work on the front development and<BR> don't have to
answer all those newbie questions. They only<BR> have to guide one
or two of the writers a little bit.<BR><BR>- let us create a hierarchical
overwiew about the main concepts<BR> in squeak for example a well
formed swikipage. This page should<BR> have all the links to
documentation. This page should be visited<BR> from the leaders
and the writers one time a year by everyone.<BR> Delete or update
Deadlinks! Order Documentationlinks in a<BR> obvious 'right' order
(think of old and obsolete pages at last).<BR> It should be
formatted in some kind of corporate design. One look<BR> and you
will know if this documentation can answer what you're<BR>
searching for (see next point).<BR><BR>- every piece of documentation should
have some attributes<BR> + a short overview about the
subject<BR> + when was it written<BR> + when was it
changed the last time<BR> + who is/are the
writer/s<BR> + who is/are the leader/s<BR> + what kind
of documentation is it ?<BR> (tutorial, architecture,
...)<BR> + what is the related squeak version<BR> + is
it obsolete ? -> point out the actual way of doing this!<BR> +
...<BR><BR>Maybe you find more points ... well let's collect them. If we want
to <BR>make squeak more popular (and I hope that everybody of us wants this),
<BR>then integrate the people who are willing to do something. Don't tell
<BR>them that there is a lack of documentation ... this lack can be found in
<BR>every thing in the world. Get them to contribute their ideas and guide
<BR>them. This is Extreme Learning !!! Learn with the help of
others.<BR><BR>I'm willing to do something. So tell me what!<BR><BR>Let's talk
about the topic and collect the main ideas. This should point <BR>out a good
way of minimizing this lack of documentation and, by the way, <BR>will help to
educate new Squeakers that may become leaders in the
future.<BR><BR>Regards<BR>
Chris Burkert<BR>--
<BR>------------------------------------------------------------------------<BR>Student
of applied Computer Science at Chemnitz University of
Technology<BR> <A
href="http://www.chrisburkert.de/">http://www.chrisburkert.de/</A>
<A
href="mailto:chbu@hrz.tu-chemnitz.de">chbu@hrz.tu-chemnitz.de</A><BR>------------------------------------------------------------------------<BR>"I
invented the term Object-Oriented, and I can tell you I did not have<BR>
C++ in mind." - Alan Kay --> <A
href="http://www.whysmalltalk.com/">http://www.whysmalltalk.com/</A><BR><BR></BLOCKQUOTE></BODY></HTML>