[gcs-pcs-list] usability of the unAPI specs, other comments

[Daniel Chudnov]

It's great to get your input, Eric. :)

Most of these are good points, but it's too many to address in one 
thread.  If you don't mind me breaking it up some...


Eric Hellman wrote, on Fri, Mar 03, 2006 at 06:14:26PM -0500:
> 
> just a few notes on usability of the unAPI spec.
> 
> 1. the unapi spec documents are undated- please annotate them with 
> the date they were published
> 2. each spec should link back to the previous version of the spec
> 3. http://www.code4lib.org/specs/unapi/ should list all version of 
> the spec somehow. http://www.code4lib.org/specs/unapi/current should 
> alias to current version.
> 4. there is no author or contact information in the dpec document - 
> if the gcs-pcs list is to be considered the author, then it should 
> say that; anonymous shouldn't use the royal we.

All good points.  I'm getting started on this.


> 5. In the interests of being accessible to the "rest of the world", 
> the name needs to be explained or at least meaning disclaimed. 
> "Universal API?"

It's not "Universal API".  Just "unAPI".

I started an FAQ and hope to have a draft written for release with the
next revision.  There's a "what's with the name?" Q in it.


> 6. "microformat" is not explained. there should be a link.
> 7. please add html name anchors so that links to spec can reference 
> fragments
> 8. please replace curly quotes in quoted code with straight quotes.

Right, easy fixes.

  -Dan


-- 
Daniel Chudnov
Yale Center for Medical Informatics
(203) 737-5789