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

[gettimothy]

> So do I. Personally I like class comments. I don't want to look for methods that contain help text. 
 
Me too. 
 
There’s nothing to prevent an extension of the HelpBrowser to have it use the contents of class comments and/or other sources of text, which would make it really easy for people to add content. 
 
We probably don’t want to clutter the image with large strings (there’s already too many) and class comments get stored in the changes which is a sensible place to have them. It shouldn’t be difficult to make any other local documentation live in the same place(s) - we only need a convention on the method name(s) to allow specified method comments to be sucked in. When online it shouldn’t be beyond us to suck in swiki page content. 
 
But the mechanism isn’t anywhere near as important as the content. Lots of us are capable of the programming for the mechanism but fewer have the writing talent to produce good documentation - let alone the time. 

 

Sounds good.



Help Browser it is. 


Chris is doing work to incorporate Wiki with it so it stands to reason that HOWTOS (besides being in the examples category and/or class comments) should reside there.


I have seen the pharo class comments integrated into help and it is a good improvement.


Personally, I am going to treat Help Documentation as I do Tests--something to implement as I code.


Thanks for the consideration.


tty




-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.squeakfoundation.org/pipermail/vm-dev/attachments/20140613/39bcb1b4/attachment.htm