Euphoria Documentation Project
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
|
Not Categorized, Please Help
|
|
