[squeak-dev] Proposing class Category README or HOWTO for easy access to documentation within the system

tim Rowledge tim at rowledge.org
Thu Jun 12 21:25:37 UTC 2014


We already have a fairly decent Help system available; see the help item in the top docking bar menus. What we lack is content for that help system, and a clear organisation of it; consider the several workspaces, the Terse Guide, the Help Browser that also includes the terse guide. I’d suspect that having a nice link to available help info from the Browser might encourage more use of it.

The tool is decent and would be better with simpler organisation, but the real missing part is content. The problem is that writing good help & tutorial content is hard work. Take a look on the swiki to see how several groups and individuals have tried to build tutorials and lost steam after a while. I’ve been trying to clean up and update some of it but it takes a lot of thought and a startling amount of time.

On the plus side, a good bit of help/tutorial on a single, narrow area is still a good bit of help. It’s not you have to write a guide to the entire system in one go. Writing help info is a very good exercise when you are learning about a new bit of the system; nothing helps you organise your thoughts and test your understanding like trying to provide a clear explanation for others.



tim
--
tim Rowledge; tim at rowledge.org; http://www.rowledge.org/tim
Useful random insult:- Puts a finger in his ear so the draft through his head isn't annoying.




More information about the Squeak-dev mailing list