[Opensource] Expresso documentation structure
Sandra Cann
scann at jcorporate.com
Fri Nov 28 22:20:17 PST 2003
Max
Thanks for your feedback.
> 1) There are far too many documents spread all over the
> place.
The primary documentation for developing is the Expresso Developers Guide -
also known as the EDG is intended as a book.
> 2) The documentation is often incomplete, wrong/old and just
> plain not there.
We'd be pleased to make updates if you can be more specific. Or better yet
help us with some editing :)
> I am suggesting the following to ease the pain for new
> Expresso programmers ...
>
> - Consolidate the documentation into:
> a) User Guide: contains description of what Expresso can do
> and installation
I think this idea is good especially if like the EDG it was organized into
Chapters making it more digestable (available in a single doc). Is this
something you would be willing to invest your "Newbie" experiences to making
this improved?
> b) Developers guide: contains *all* coding development
> related documents.
Definitely +1 for this as well.
> c) Tutorials. Yeah I know these don't exist.
It does exist! Have a look at Project link in Header > Examples link >
Downloads
> open source success story that doesn't have a tutorial.
> d) Examples. Expresso *desperately* needs more exmaple
> code.
There are 3 so far. We'll get yours onsite shortly. Can you send a copy to
support @ jcorporate.com I'll get the appwriter links which not longer work
deleted before 5.3 is released.
> - Scrap the online faq and forum - they're useless. ...
> They also dipict such a low level of
> activity it caused me to rethink my choice in Expresso.
Not sure where you are looking but Expresso Users forum has very decent
activity. :)
> - Make the mailing list more prominant.
How would you like me to do that? Bigger font? Different location onsite?
> I think that Expresso can be an open source hit, however the
> folk at jCorporate need to focus attention on reducing
> the learning curve for newbies.
AGREED! People that go through the learning curve are the best folks to show
us how. Sometimes the experienced users are just too close to it to know
anymore what newbies need.
This is a community effort. We welcome new contributors and encourage
everyone to be involved.
There is a lot of focus on docs. On the last release we gave away 2 very
nice color pdas for the best document contributions - both went to newbies.
Doc is something we take seriously. It is regularly updated.
> what is the future of the product?
You can find roadmap documents under the documentation "Design & Planning"
section.
> I'd like to make a contribution to the Developers Guide.
Awesome! We'll respect your wishes to see if incorp into the EDG. Thanks for
the contribution. We look forward to your further suggestions.
It is much appreciated that not only are you voicing your suggestions but
also helping to make them happen!
Thanks again
Sandra
More information about the Opensource
mailing list