[Webware-devel] Re: Webware Docs

[Ian B. <ia...@co...>]

Yes, there's some stuff I haven't really completed --
ApplicationDevelopment and Tutorial.  Tutorial is no big deal, but
ApplicationDevelopment is meant to be something of a replacement for the
UserGuide.  But for the actual release, the installation guide is the
most important part that needs to be updated -- I don't think it's had
any significant revisions in quite a while, and is incomplete and
probably inaccurate.

Also we don't yet have good reference documentation.  I don't believe
there's anything started for that yet.  I'm not sure about the best way
to do that.  That's going to be mostly tied to modules, functions, and
classes, so the organization is easy.  But I'm not sure where to put it
-- docstrings or standalone files, and if docstrings, should it be
module, class, or method/function docstrings.  

Anyway, the reference guide is probably second after install guide in
terms of importance.

I hate installation stuff.  I can give a wack at a reference guide if
someone else can take the installation stuff.

On Tue, 2003-01-14 at 17:05, Stuart Donaldson wrote:
> Hi Ian!
> 
> You were doing some stuff with the docs a while back.  I wanted to 
> check-in with you and see where you thought you were, and what you 
> thought needed to be done with them.
> 
> I'd like to have them updated for our release candidate build which I 
> would like to do early next week.
> 
> If they're up to date as far as you know, that's great, if they need 
> more work prior to this release, do you think you might have some time 
> to take a stab at it?
> 
> Thanks...
> 
> -Stuart-