SourceForge : Post

Project: Editor Discussion > INFO:OGSA EMS Architecture Scenarios v1.0 > Useful document, acronyms and refs need to be cleaned-up > List of Posts

Forum Topic - Useful document, acronyms and refs need to be cleaned-up: (2 Items)

View: as

Update

Blair Dillaway

03/21/2007 1:51 PM

post5778

Useful document, acronyms and refs need to be cleaned-up

This scope of use cases described, and how several different ‘recommendation’ track specifications, can be used to 
address them, seems useful. I do, however, think this document will be very challenging for people not intimately 
familiar with existing OGF specifications and activities. In particular, it uses acronyms extensively and has no 
consistent approach to defining them. Acronyms are often used repeatedly before being spelled out and/or the defining 
specification is cited. Some examples:

BES – first used in 2.1.1, first reference provided in 2.1.4, first spelled out in the Glossary
EPR – first used in  4.1.3, not spelled out nor is any reference to the defining spec provided. I assume you mean a WS-
Addressing EndpointReference?
JSDL – first used in 2.1.3, first reference in 2.1.4, first spelled out in the glossary
CDL – first used in 3.1.5, first reference in 4.1.4, first spelled out in the glossay
RNS – used and spelled out in 4.2.5, no reference cited

Couple of other items.
1) In 4.1.4 it says ‘Deployment API[GFD.69]’ then in 4.1.5 it says ‘CDDLM Deployment API[GFD.69]’.  Use the latter 
language in 4.1.4 and don’t re-cite the reference in 4.1.5
2) Most references are re-cited (BES, JSDL, …) in every section which should be unnecessary 
3) You should define ‘user agent’ and ‘job manager’
4) Cite the glossary in the intro to aid the reader or move it to the front of the document

Andreas Savva

04/18/2007 5:34 AM

post5795

Re: Useful document, acronyms and refs need to be cleaned-up

I have 
- added an introductory section that gives a short summary of each specification and expands acronyms.
- mentioned the Glossary in the introduction.
- expanded EPR and provided a reference to WS-Addressing
- expanded RNS and provided a reference to the RNS specification
- Used "CDDLM Deployment API" as suggested

I have left in most of the re-citations because, even though somewhat redundant, can be useful when looking up a 
particular section of the document rather than reading through from beginning to end.  

I have not added text for ‘user agent’  and ‘job manager'. 
- User agent is used with what I think is its generic meaning of 'client application.'
- There is an entry for Job manager in the Glossary. 

Thank you for the detailed comments.

Return