OpenEuphoria

Documentation Project

• Posted by simulat <simulat at INTERGATE.BC.CA> Apr 05, 2000
• 413 views

------=_NextPart_000_001F_01BF9F25.415A3360
        charset="iso-8859-1"

Hi
Sorry to drop out of sight about the documentation project. I had a bit of
an encounter with a car while riding my bike and that distracted my
attention a bit. All's well on that front I guess - so onwards and upwards.

I'm very pleased in the interest and in the offers of translation. The
translation seems to me to be a bigger job than the documentation itself,
but would be really worthwhile.

From the posts from Raude and Greg I see the need for a coordinator, and
until people start complaining a lot, I guess I'll take on that role. But
I've never done it before - so I'll be a bit clumsy at it. The way I would
like to work is to put forward proposals for various protocols, etc for
suggestions and comments. If there's lots of discussion, then I won't do
anything till the discussion dies down and some kind of consensus is
reached - but if there is no discussion I'll just do what I think is best.

To start this off, I think that building up an FAQ will be my first project.
Attached to this message is a proposed format for FAQ documentation requests
and responses. The idea is that if people post their requests for
information in a standard format, and post the responses to those requests
in a related standard format, that it will be easy to automatically gather
that information into a larger document.

So - attached to this message is a propose format for FAQ Requests, and
another format for FAQ responses. I'm working on a tool that will take that
information and dump it into a database. Subsequently I'll make a tool that
formats the database into a readable document.

So please have a look at the formats and offer suggestions if you want. And
if someone wants to try out an actual request and response cycle that would
be cool too, because it would give me some real material to work with as I
develop the tools.

As always, comments, suggestions and criticisms are very welcome. And if
anyone wants to volunteer to take on any of the tasks involved, feel free.

Bye
Martin


------=_NextPart_000_001F_01BF9F25.415A3360
        name="EuFAQ.txt"
Content-Transfer-Encoding: quoted-printable