[squeak-dev] Rethinking Help

gettimothy gettimothy at zoho.com
Fri May 15 19:40:44 UTC 2020


Hi Folks.



Just a brainstorm here.



We ask Objects and Classes for stuff every day. What if we could send them the "help" message?



OrderedCollection help.

1 help.

'1' help.

Stream help.
CompiledMethod help.

Pragma help.




Frameworks...



Seaside help.

PEGParser help.

Xtreams help.

SUnit help

VMMaker help

OSProcess help.



"Any package category in the browser" help.



What if Lawson English' videos where available right in the OpenGL package?

OpenGL help.







Make complicated design patterns, like the Tree traversal stuff folks on the pharo boards are discussing objects.




Tree help.

FactoryPattern help

SingletonPattern help.





Furthermore, make it trivial for anybody to directly write the help into the object. (This is a huge drawback for the current Help system. I do not want to program Help topics, I want to cut-n-paste some text very quickly)




For example, Levente has been very helpful in providing advice on using the XTreams-Parsing package.

It would be very helpful, to just copy-n-paste the emails/conversations  as they happen into the Package's help.



Ditto for PG3. 



PG3 help viewall

PG3 help byDate.

PG3 help latest

PG3 help authors




Make sense?





Class comments are frequently empty stubs.



Furthermore, we have billions (: of smalltalkers out there. Make it easy for them to "commit" their help into the core system on squeaksource from within the image (or make it semi-automatic)



I think it would be a great first-step for aggregating help content and making it easily accessible from within a Workspace.



I honestly "never" use the Help system as I find it awkward and inefficient to read and code. However, for those who do enjoy it, an in-image aggregation system would help its development too.



cordially,



tty
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.squeakfoundation.org/pipermail/squeak-dev/attachments/20200515/204ea043/attachment.html>


More information about the Squeak-dev mailing list