OpenEuphoria

Re: Euphoria Documentation Project

• Posted by Dan B Moyer <DANMOYER at PRODIGY.NET> Apr 08, 2000
• 562 views

Martin,

I like the idea of some more documentation for Euphoria very much, but I
have to agree with John McAdam that your question/response protocols are too
off-putting.  I can understand your desire to reduce the labor intensive
nature of the project, but I think his idea of a question form to fill out
on a web site is much better, although I wouldn't want it restricted to just
web ring members.

As an alternative, when I first noticed the unfortunate lack of a Euphoria
FAQ, my thought was that everyone who asks questions on the list could
"re-pay" the general helpfulness of the list members by contributing their
questions & received answers to a FAQ, thus distributing the load for
creating it.  I assume that most who ask questions probably *save* the
answer(s) they receive, for future reference, and could relatively easily
sort through them on a monthly basis & send their questions & the answers(s)
to whoever might be maintaining the FAQ, which could then be copied to
various member's web sites.  At worst case, list members could sort through
the list archives for some of their own questions, & pick good answers to
send in for the FAQ.

Dan Moyer

-----Original Message-----
From: simulat <simulat at INTERGATE.BC.CA>


>Hi
>
>Some initial thoughts about a Euphoria Documentation Project:
>
>Here's one idea that might work.
>
>A programmer discovers a problem in the docs - something is missing or
>unclear. They post their observation. Someone who is knowledgeable about
the
>issue writes an article. The article is posted for review and comment.
After
>the review and correction (if needed) the article gets incorporated into
the
>final Manual, FAQ, or HowTo.
>
>For those who are looking for projects, there are a bunch of little
software
>entities that could be made to support this effort. We could have a set of
>programs that are forms into which documentation requests and the
>documentation itself could be typed. This would greatly simplify the use of
>the tags that would then facilitate the rest of the document creation
>process. We could have other programs that translate the tagged document
>into various format like rich-text and html, and whatever the format used
>for the compiled html of Adam's new Manual.
>
>Part of our strategy should be to keep each task very small, and by
>automation to eliminate as much of the drudgery as possible. It might be a
>good idea to use the way data is transmitted on the net as a model for how
>we handle the tasks. The projects should be broken down into small,
>semi-autonomous little chunks, that are labeled in such a way that they
>automatically assemble themselves into the finished document without there
>having to be an overall author or editor.
>
>Anyone have any thoughts on this?
>
>Bye
>Martin


and John McAdam responded to some zipped up suggested question/answer
protocols contained in another post:

<The proposed model looks pretty difficult for us simpletons.
If this was a web page where you could fill in some form
of the kind you suggest it might be viable. The web page
could be clickable from members of the euphoria web ring.
Then another form for answers... Hmmm...This is a lot of
extra work for us. Keep thinking.>