[Tiny-cobol-users] Documentation: Documentation Project

[Jim M. <ro...@vi...>]

To all TC users.

The Documentation project is now officially started.  The team members so
far are listed below.

I think all communication should be through the TC mailing list as far as
possible.  This will ensure that we all know what is going on and will also
let everyone else know that there is activity.

Please prefix all messages with "Documentation:".

Some folks want to start on "small" documents.  Others want to start with
the Reference manual straight away.  We have enough people that we might be
able to do both.

Mohamed has volenteered to help me co-ordinate things and will be starting
off with the Reference manual straight away.  In true Open Development
style, we'll just jump in and sort out all the problems as we go.

We will use the ISO/IED FDIS 1989 standard as a basis of our reference
manual.  Who does not have a copy and needs me to email it to them?

We haven't finalised the tools we will use, so send as much as you can in
straight ASCII text.  We'll work out things as we go.

Glen has suggested Open Office on the basis that it can also produce DocBook
stuff as well as importing & exporting MS Word.  Hudson had some other
sugestions.  What does everyone else think?

I suggest that we start by documenting the PROCEDURE DIVISION.  The simplest
statement I could think of to start with is the "ADD" statement.

I suggest we have:

1.    Brief Summary of the command.  (Mohamed, will you give us a first
draft of this)

2.    The Syntax Diagrams (Glen C, could you re-type the diagrams for Add)

3.    A fulled explanation of how the command works

4.    Simple examples

5.    Interesting examples (where appropriate)

6.    Finally, all the stuff from the Standard.


We will start a new statement every few days and run them concurrently.

Jim


The team members so far are:



Jim Morcombe ji...@by...
Mohamed Noorani mo...@by...
Wim Niemans  ni...@pb...
Diego Gil  da...@la... (Spanish & English)
Tom Chandler  tch...@ra...
Glen Cunningham gl...@tp...
Kevin Monceaux  Own...@gr...
Vince Coen   vb...@bt...
Fred Mobach   fr...@mo...

Translators (Spanish) :
Juan J. Martinez  jj...@us...
Diego Gil  da...@la...