[Design] How-to Tutorials (Was: review documentation autogenerators)

[David Jeske]

On Fri, Feb 28, 2003 at 12:02:52PM -0800, Kaitlin Duck Sherwood wrote:
> We recognize the importance of good developer documentation and were 
> wondering if (hoping) that some such tool would help.

While I agree you should have auto-generated reference docs, I find
references, especially auto-generated ones, extremely unhelpful when
trying to understand a new piece of software.

I've created a Wiki page detailing some important elements of more
"tutorial oriented" documentation, including examples which succeed.

 http://wiki.osafoundation.org/bin/view/Main/HowToTutorials

-- 
David Jeske (N9LCA) + http://www.chat.net/~jeske/ + jeske@chat.net