<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
</head>
<body>
<p>Hi Folks,</p>
<p>Yeah again this boring topic of documenting... But for a
community to grow you need some documentation. <br>
</p>
<p>From the feedback we regularly receive in the mailing list, we
can say the <a moz-do-not-send="true"
href="https://cuis-smalltalk.github.io/TheCuisBook/">The Cuis
Book</a> was and is a worthy effort. With Ken and Juan we
discussed about the target audience, its contents and scope, and
also its limitation. It does not present every facet of Cuis, it
is a gentle introduction to basic programming, Smalltalk and Cuis,
a sort of appetizer.</p>
<p>I would like to discuss with you the next step in term of
documentation. Indeed there are many topics we do not cover in
detail or at all which could be useful to improve the experience
of the developers. Among them Layout, VectorGraphics, GUI
building, Event, Error handling, etc. <br>
</p>
<p>Nevertheless, there is already <a moz-do-not-send="true"
href="https://github.com/Cuis-Smalltalk/Learning-Cuis">Learning-Cuis</a>
documentation, but I have doubt about github wiki for large
documentation, may be I am wrong. There is also the embedded
documentation from the Terse Guide. These useful documentations
are in different places and formats, it does not ease the access
to documentation. <br>
</p>
<p>We should get it all in one place: easy to access and to
contribute too. Therefore as a medium we may want to use something
flexible as a wiki or equivalent.<br>
</p>
<p>Regarding its content, we can discuss here the topics most of you
will be interested by, after all this is the best way to have
meaningful documentation. Also discussing how to structure the
contents to prevent it to become too quickly a mess. Such contents
will be a place of reference when a user needs some information or
know how. In my opinion, such documentation is fundamental to see
a growing Cuis community.<br>
</p>
<p>Concerning contributions, all users are concerned. Even a casual,
new user of Cuis who has just finished reading the Cuis book could
contribute. In fact, documenting a topic you are learning is an
awesome mean for deeper learning. In education this is something
we do often through learning by the pair.</p>
<p>Let's the discussion begin :<br>
</p>
- Topics of interest
<p>- Format, placeĀ to document<br>
</p>
<p><br>
</p>
<p>Hilaire<br>
</p>
</body>
</html>