Documentation

[Jon Parise]

I'm going to start poking at the documentation infrastructure in
my free time (I'll make some if I need to).

We already have a good deal of foundation layed (thanks Anil!),
so a lot of the grudge work is out of the way.

I'm curious how we want to organize the documentation, though.
At the moment, it looks like we'll be storing all of the modules'
documentation in the same manual.  Is that desirable?  Should we
have separate manuals for each application?  We could probably
build one big manual from all of those, too, in case anyone
wanted everything in one place.

Thoughts and comments on the documentation in general are highly
appreciated.

Oh, and if you want to see an example of what's being generated
now, have a look here:

    http://indelible.org/work/docs/html/
    http://indelible.org/work/docs/web/

-- 
Jon Parise (jon@csh.rit.edu)  .  Information Technology (2001)
http://www.csh.rit.edu/~jon/  :  Computer Science House Member


>From jan@horde.org Date: Fri,  5 Oct 2001 17:47:28 +0200
Return-Path: <jan@horde.org>
Mailing-List: contact dev-help@lists.horde.org; run by ezmlm
Delivered-To: mailing list dev@lists.horde.org
Received: (qmail 89790 invoked from network); 5 Oct 2001 15:56:22 -0000
Received: from mailout04.sul.t-online.com (HELO mailout04.sul.t-online.de) (194.25.134.18)
  by clark.horde.org with SMTP; 5 Oct 2001 15:56:22 -0000
Received: from fwd02.sul.t-online.de 
	by mailout04.sul.t-online.de with smtp 
	id 15pXJ4-00023c-07; Fri, 05 Oct 2001 17:54:34 +0200
Received: from linux.wg.de (320034214675-0001@[217.80.111.25]) by fmrl02.sul.t-online.com
	with esmtp id 15pXIQ-02gddYC; Fri, 5 Oct 2001 17:53:54 +0200
Received: from localhost (localhost [127.0.0.1])
	by linux.wg.de (8.11.0/8.11.0/SuSE Linux 8.11.0-0.4) with ESMTP id f95FlTc22841
	for <dev@lists.horde.org>; Fri, 5 Oct 2001 17:47:29 +0200
Received: from 192.168.60.1 ( [192.168.60.1])
	as user jan@mail.wg.de by linux.wg.de with HTTP;
	Fri,  5 Oct 2001 17:47:28 +0200
Message-ID: <1002296848.3bbdd6108e81d@linux.wg.de>
Date: Fri,  5 Oct 2001 17:47:28 +0200
From: Jan Schneider <jan@horde.org>
To: dev@lists.horde.org
References: <20011005114143.A25232@csh.rit.edu>
In-Reply-To: <20011005114143.A25232@csh.rit.edu>
MIME-Version: 1.0
Content-Type: text/plain
Content-Transfer-Encoding: 8bit
User-Agent: Internet Messaging Program (IMP) 2.3.7-cvs
X-Sender: 320034214675-0001@t-dialin.net
Subject: Re: [dev] Documentation

The generated html documentation looks good and I would prefer to have the 
documentation of all of the horde framework in one seperated module.

Jan.

Zitat von Jon Parise <jon@horde.org>:

> I'm going to start poking at the documentation infrastructure in
> my free time (I'll make some if I need to).
> 
> We already have a good deal of foundation layed (thanks Anil!),
> so a lot of the grudge work is out of the way.
> 
> I'm curious how we want to organize the documentation, though.
> At the moment, it looks like we'll be storing all of the modules'
> documentation in the same manual.  Is that desirable?  Should we
> have separate manuals for each application?  We could probably
> build one big manual from all of those, too, in case anyone
> wanted everything in one place.
> 
> Thoughts and comments on the documentation in general are highly
> appreciated.
> 
> Oh, and if you want to see an example of what's being generated
> now, have a look here:
> 
>     http://indelible.org/work/docs/html/
>     http://indelible.org/work/docs/web/
> 
> -- 
> Jon Parise (jon@csh.rit.edu)  .  Information Technology (2001)
> http://www.csh.rit.edu/~jon/  :  Computer Science House Member
> 
> -- 
> Horde Developers mailing list: http://horde.org/
> Frequently Asked Questions: http://horde.org/faq/
> To unsubscribe, mail: dev-unsubscribe@lists.horde.org
> 
> 


:::::::::::::::::::::::::::::::::::::::: 
AMMMa AG - discover your knowledge
:::::::::::::::::::::::::::
Detmolder Str. 25-33 :: D-33604 Bielefeld
fon +49.521.96878-0 :: fax  +49.521.96878-20
http://www.ammma.de
::::::::::::::::::::::::::::::::::::::::::::::