[Opensource] Expresso documentation structure]
Sandra Cann
scann at jcorporate.com
Wed May 12 12:11:29 PDT 2004
Max
Since your excellent posting in Dec we have taken to heart and implemented
many of your suggestions -and you can find them now on the doc onsite.
> I checked the
> site carefully (or so I thought) for a tutorial when
> starting out a few weeks ago and couldn't find one. My
> apologies to Tino, but this also highlights the problem of
> finding the right documentation amongst all of the other doc's.
There were many docs on the doc page. They have been reworked as several
docs often covered similar topics. For example all of the component overview
chapters are now integrated into the appropriate chapter in the EDG. (I
think this was your suggestion as well) You'll find the doc page simplier to
locate the information you need now. The tutorial is now more obviously on
the expresso doc page.
> > >- Indicate in the documentation what version of Expresso
> it covers.
The doc is now updated to reflect what version it pertains to. For the
components, such as eForum, you'll see that the version also references in
the download notes what version of Expresso it relates to too.
Each EDG document now has a maintainer too- that corrections, comments and
contributions can be sent to. While David is listed as the maintainer for
many of the EDG docs, he welcomes anyone wishing to adopt a chapter as
maintainer. Just drop a note letting us know. This process of assigning a
chapter to an individual will result in even better documentation I have no
doubt- as it becomes a reflection of that individual's knowledge and
personal pride.
> > >I'd like to make a contribution to the Developers Guide.
> From a post
> > >yesterday some of you may know that I am
> > >struggling with the Expresso workflow
You'll notice your edg contributions have been implemented for sometime and
are online.
> I do however always
> make an effort to make some constructive input if I am
> going to critisize.
I hope we can look forward to your feedback on the changes (massive) we have
made.
> I found a free docbook word processor type editor called
> XMLmind. It can be downloaded at www.xmlmind.com.
I used xmlmind in all of the EDG document editing in preparation for
Expresso 5.5. I was working in it right away and productive. I had a few
questions which David L was kind enough to help me with that had me cranking
out a lot of revised doc. It really made the job easy. I encourage anyone to
download (I used the free version) and try this product. I anyone wants to
help with edg doc revisions and have some questions while working with
xmlmind feel free to IM me a javapowered @ h o t m a I l . C o m.
Thanks again for the input.
Sandra
More information about the Opensource
mailing list