eml documentation

[David Blankman]

The documentation is a good start. 

Questions:

1. What is the purpose of this documentation? Who is the target audience
for this documentation? Is this  "developer" documentation?  Is this
"user" documentation? Is it supposed to be for both groups?

2. How should Chris and I work together?  I am working on documentation
of EML for LTER sites, KNB Seminars and ecologists generally?

Comments:
Without knowing the purpose/audience for this documentation, it is
difficult to make substantive comments.

Suggestions:
The list of modules should start with a list of the modules with
hyperlinks to the detailed descriptions.







On Thu, 2002-05-30 at 13:45, Chad Berkley wrote:
> Hi again,
> 
> Please take a look at
> http://trestles.nceas.ucsb.edu:8080/beta/docs/eml-docbook.html
> and let Chris and me know what you think.  Specifically, we would like
> comments on the preface, the usability of the index and the quality of
> documentation provided for each module.  Obviously some of this
> documentation is now wrong because we generated this last week and there
> have been significant changes since then so don't check it for
> accuracy.  We just want comments on the big picture.  Also, note that
> displays like this are where all the documentation in the schema files
> is actually shown to the user, so it is important that every module and
> every element be thoroughly documented.  If you find an element or
> module with lacking documentation, look first at the xsd file to make
> sure more docs haven't been already added, and if they haven't, send a
> note to eml-dev with the name of the module and the name of the element
> that needs more documenting (or if you're feeling like a good time, and
> you know the definition of the element, you can redocument it yourself
> and check it in to CVS).
> 
> thanks,
> chad
> -- 
> -------------------------------
> Chad Berkley
> National Center for Ecological
> Analysis and Synthesis (NCEAS)
> 735 State St. Ste. 204
> Santa Barbara, CA 93101
> 805-892-2530
> berkley at nceas.ucsb.edu
> -------------------------------
> 
> _______________________________________________
> eml-dev mailing list
> eml-dev at ecoinformatics.org
> http://www.ecoinformatics.org/mailman/listinfo/eml-dev