[squeak-dev] Documenting the system

Eliot Miranda eliot.miranda at gmail.com
Thu Jul 22 22:10:22 UTC 2021


Hi Ron,

On Fri, Jul 16, 2021 at 1:27 PM Ron Teitelbaum <ron at usmedrec.com> wrote:

> Thanks Tim.
>
> A few questions for everyone.  https://forms.gle/CsEpHvipoGbeud9k8
>
> If you have a minute please take a moment to answer this anonymous survey
> in google forms.
>

This needs more yes/maybe/no or yes/somewhat/no options, and less yes/nos.
I don;t find uch in the HelpBrowser because I'm an expert, but that doesn't
mean I find it useless.  I do find some of the examples a little old or
incomplete.  But on the whole the Help Browser is a good thing (tm).  I'm
not sure your survey allows one to say "it's good, but iot could be
better".  It feels like it accepts only good or bad as options.  Viva the
excluded middle!


> Thank you!
>
> Ron
>
> On Fri, Jul 16, 2021 at 1:14 PM tim Rowledge <tim at rowledge.org> wrote:
>
>>
>>
>> > On 2021-07-16, at 8:49 AM, Ron Teitelbaum <ron at usmedrec.com> wrote:
>> >
>> > Hello everyone,
>> >
>> > Hope everyone is doing well.
>> >
>> > How do we document Squeak?
>>
>> Don't forget the HelpBrowser. There are already some quite good pages in
>> there and there should be a lot more. My suggestion would be that the
>> HelpBrowser should include basic information and guides on how to use stuff
>> - ie the sort of info that really doesn't fit well into class comment
>> organisation - with pointers to more extensive doc on the Swiki.
>>
>> We *could* make it possible to load that Swiki info directly, or we could
>> include the 'start up a web browser on this link' stuff from the
>> ScratchPlugin.
>>
>> Obviously the key issue is getting people to write anything, anything at
>> all, by way of documentation. It doesn't seem to be a popular hobby.
>>
>>
>> tim
>> --
>> tim Rowledge; tim at rowledge.org; http://www.rowledge.org/tim
>> USER ERROR: replace user and press any key to continue.
>>
>>
>>
>>
>

-- 
_,,,^..^,,,_
best, Eliot
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20210722/62c374b9/attachment.html>


More information about the Squeak-dev mailing list