[evla-sw-discuss] Document numbering

[Bill Sahr]

With the release of requirements documents for the EVLA software, 
the issue of document numbering has arisen.  I am currently aware 
of two documents on this topic - "EVLA Documentation Numbering 
Specification", A23010N0001, by K. Tate & W. M. Koski,
to be found at:

/evla/techdocs/sysintegrt/system_documentation_standards/A23010N0001.pdf

and "EVLA Correlator Document Numbering Plan", A25000N0000, by
Brent Carlson, to be found at:

http://www.drao.nrc.ca/science/widar/private/Management/a25000n0000_docnumbe..

In the first document, the Computer Division is assigned project
numbers
in the range 24000 - 24999.  In the second, software documents
relating
to the correlator are given the ranges 25200 - 25249 for correlator
monitor and control, and 25250 - 25299 for correlator backend.

Already, an ambiguity has crept into the numbering system.  The
document
authored by Tom Morgan, a member of the Computer Division, which
describes correlator backend software requirements carries the number
A25251N0000.  The project number, 25251, fits with Brent's numbering
scheme for the correlator, but not with the 24000 - 24999 range
assigned to the Computer Division.

I propose the following:

1) A document carrying the number A24000N0000 be created which
   will describe the numbering scheme to be used for software
   documents.

2) Brent's use of the project numbers 25200 - 25249 for correlator
   monitor and control software documents and 25250 - 25299 for
   correlator backend software documents be retained.

3) A set of categories with associated project numbers, in the
   range 24000 - 24999 be established for EVLA software documents.

4) My initial, proposed set of categories & project numbers are 
   as follows:

   24010 - Antenna Monitor and Control  (AMCS), including but not
           limited to the Requirements document.
   24050 - Operational Interface, including but not limited to
           the upcoming release of version 2 of the Requirements
           document,
   25200 - 25249 - Correlator Monitor & Control Software Documents
   25250 - 25299 - Correlator Backend Software Documents

   with Tom Morgan's document on Correlator Backend Software
Requirements
   retaining the number A25251N0000.

The numbering scheme as a whole provides 4 fields:
<sheet size> <project number> <drawing type> <drawing number>

Documents are normally size "A".  Project numbers as per this
discussion.
Drawing type "N" is for "specifications", and the drawing number is a
4 digit field.  So, A24010Nxxxx would normally be used for AMCS 
documents, giving us a range of 9,999 documents, and A24050Nxxxx
would be used for Operational Interface documents.  If necessary,
AMCS & Operational Interface documents can be assigned a range of
project numbers, i.e., 24010-24049 for AMCS, etc if this system leads
to an easier to use or more logical categorization as our
documentation
evolves.

Please DO comment on these suggestions.  We do not want to have to
go back and renumber at a later date, if it can be avoided.

Bill