eml documentation and IDs

[Corinna Gries]

Hi Chad and Chris,

I just checked out the documentation and I think it looks great. (Found two
typos, in the intro there is a 'by' that should be 'be' and in the
architecture is a 'iand', nothing major, obviously.) I assume that you'll
change the modularity section a little to reflect how this is done now. The
index very useful, it gives a quick way to get information about a single
element.

And my two cents on IDs, they would make it easier to work whith these
repeating sections.

Corinna

-----Original Message-----
From: Chad Berkley [mailto:berkley at nceas.ucsb.edu]
Sent: Thursday, May 30, 2002 10:46 AM
To: Eml-Dev (E-mail)
Subject: eml documentation


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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mercury.nceas.ucsb.edu/ecoinformatics/pipermail/eml-dev/attachments/20020603/140746c5/attachment.htm