> -----Original Message-----
> From: Leo Simons [mailto:[EMAIL PROTECTED]
> 
> word of caution: writing big pieces of comprehensive documentation is
> very challenging; so is maintaining them. Various people have repeatedly
> failed at maintaining "comprehensive" documentation on stuff, here, and
> elsewhere. I think Steve, with the merlin tutorials, figured out how to
> do it nicely: write small, relatively disjoint "howto"s or essays, then
> link those together (using navigation.xml, mostly :D) into something
> with a bit more unity.
> 
> That way, when you have an itch to document something, you can scratch
> it in an hour.
> 
> Having said that, writing a big piece of well-written software manual is
> a bigger challenge, and hence may be more fun to do. Just make sure
> you're able to complete what you started; that's always been a problem
> for me :D
> 
> cheers,
> 
> - Leo
> 

You make a really good point Leo.  For most of our documentation, I think
the disjoint HOWTO approach works well, though I'd still like to see
something more cohesive and complete for a beginners guide.


J. Aaron Farr
  SONY ELECTRONICS
  DDP-CIM
  (724) 696-7653

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to