[DDI-SRG] Field level documentation

[Wendy Thomas]

Review of field level documentation will begin with the publication of CR3 
on February 11. Mary and Sanda will go over all of the field level 
documentation and submit changes via mantis (Sanda has access, Mary will 
need access). This work will be completed by March 13. I will go to Ann 
Arbor March 3-4 to help clarify any questions or problem areas and be sure 
that the high level documentation reflects their insight and comments.

Once the CR3 is out we are doing all updates in real time which means we 
need to deal with avoiding version conflicts and also dealing with any 
content changes which will require documenation review. We have a couple 
options in terms of the field level documentation.

1- Enter it as they report it
2- Enter it weekly (or other periodicity)
3- Enter it at the end

We need to work out with J and Pascal the best approach for this. Current 
preference is for option 2 which can be scheduled so that it does not 
conflict with other update work.

Changes will be reported in Mantis under Category "Documentation-Field 
Level" and include:

Related Module

Summary: Element name

Description: OLD content: cut and paste of the original

Proposed Solution: NEW content: cut and paste version of what they want 
in there

This would give us a record of what was changed as well as the old and new 
copy. It also means we can just copy and paste into the appropriate location 
and verify that it is consistant for all uses of the element. Wendy will 
be doing the actual update.

Any changes we make in elements/attributes subsequent to CR3 should result in 
the following:

Wendy will be responsible for informing Mary and Sanda of real time 
updates and changes (sending a clip of the changed item and its 
documentation). They can then review and post any required documenation 
changes to Mantis. Include the bug number of the content change for 
additional reference if a documentation correction needs to be made.

They would start their process February 11 with the publication of CR3 and need 
to complete their work by March 13.

This has been discussed with Mary and Sanda and ok'd by Arofan.

Wendy


Wendy L. Thomas                          Phone: +1 612.624.4389
Data Access Core Director		 Fax:   +1 612.626.8375
Minnesota Population Center              Email: wlt at pop.umn.edu
University of Minnesota
50 Willey Hall
225 19th Avenue South
Minneapolis, MN 55455