Hi,
> Hm. This might be the right time to discuss how to produce a better
> documentation ;)
> How is today's documentation effort organized, and how can we organze it to
> get the effort going. I think one of the things that we could benefit a
> great deal from was if the different issues that are discussed in the
> maillinglist are somehow transferd to the manual
Please see the post about Requirements and Annotations, I sent it to
the list yesterday. This is our proposed solution for engineering
software and producing documentation. Requirements define what needs to be
done and they tell writers what's going to be developed and why. The
Annotations is simply a feedback form that you can access while reviewing
a document.
IMO, it's not possible to extract publishable documentation from mailing
list conversations. Try it! The Requirements forum is not a discussion
forum. It's a place to present proposals and arguments. Requarding the
available 2.0 document "mgd20", when a proposal is accepted it's then a
requirement that's commited to the CVS version of the document. After
requirements are identified, then solutions can be explored.
Please follow the link on the front of www.midgard-project.org titled
"Requirements" This is where the documents for the 2.0 design are going,
it's also where the new 1.4 manual and the Web site redesign are going.
These documents are open for your feedback in a forum that's designed to
produce publishable results. Our documentation will start with these
Requirements documents. Unless someone can demonstrate a better way.
The program is just beginning so there's many things to learn. Look at it,
submit a proposal. Express your opinion on the list about the Requirements
concept.
We'll be posting a manual for 1.4 later today or tomorrow. That document
will go into the annotations system just like the Requirements for 2.0.
This manual will be in a beta stage with some chapters being alpha. We're
going to desperately need everyone to contribute towards completing the
manual.
Cedric is going to upload the Midgard 1.4 Manual to CVS now. We'll get it
into the Annotations system within a couple hours.
An additional note, all Midgard graphics are being produced with "dot."
They're text based files that can live in CVS and be edited by anyone.
Well, I hope this helps. More than anything else, I want to emphasize that
we need help putting our new system into a working phase.
Ron Parker
>
> Tarjei
>
> > -----Original Message-----
> > From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]]On Behalf Of Emiliano
> > Sent: 3. oktober 2000 17:22
> > To: [EMAIL PROTECTED]
> > Subject: [midgard] Another PHP project
> >
> >
> > Check it out at http://www.muze.nl/software/ariadne/. Haven't
> > looked at it too closely but there may be concepts worth borrowing.
> >
> > Emile
> >
> > --
> > This is The Midgard Project's mailing list. For more information,
> > please visit the project's web site at http://www.midgard-project.org
> >
> > To unsubscribe the list, send an empty email message to address
> > [EMAIL PROTECTED]
>
>
> --
> This is The Midgard Project's mailing list. For more information,
> please visit the project's web site at http://www.midgard-project.org
>
> To unsubscribe the list, send an empty email message to address
> [EMAIL PROTECTED]
>
>
--
This is The Midgard Project's mailing list. For more information,
please visit the project's web site at http://www.midgard-project.org
To unsubscribe the list, send an empty email message to address
[EMAIL PROTECTED]
