RE: [ubl-dev] Best practice for schema and versioning documentation

Title: Message

Hi Sol,

 

At LMI, we are including schema level documentation as part of a 
schema implementation guide rather than in the schema itself.  However, if 
you have a business case to include in the schema, I would suggest that it would 
be entirely appropriate to include it as part of the annotation documentation 
for the root element.

 

Mark
Mark R. 
Crawford

Senior Research 
Fellow - LMI XML Lead
W3C Advisory Committee, OASIS, Representative
Vice 
Chair - OASIS UBL TC, UN/CEFACT Applied Technologies Group 
Chair - 
UN/CEFACT XML Syntax Working Group
Editor - UN/CEFACT Core 
Components

 

LMI Government 
Consulting
2000 Corporate Ridge
McLean, VA 
22102-7805
703.917.7177 Phone
703.655.4810 
Wireless
The opportunity to make a difference has never 
been greater. 

www.lmi.org 

 

  

  
  From: Safran Sol [mailto:] 
  
Sent: Wednesday, May 04, 2005 9:48 AM
To: 
  
Cc: Triplett John A; Morgan Kathleen 
  C
Subject: [ubl-dev] Best practice for schema and versioning 
  documentation

  

  
The US IRS is in 
  the process of revising its XML NDR to align with UBL 1.0.

  
 

  
During our most 
  recent working session, we discussed that the DOC ndr did not specifically 
  include schema level documentation. For the IRS, this is documentation that 
  applies to the schema rather than the schema components. We also 
  discussed a need to document the rationale or reasons for version changes 
  and where it would be appropriate to place this 
  information.

  
 

  
Our 
  questions: Has anyone addressed these type concerns? What practices do 
  your firms utilize? 

  
 

  
We would 
  appreciate any suggestions you could provide.

  
 

  
thanks

  
 

  
Sol Safran

  
Enterprise Data 
Management

  
301.429.7543

  
Cell: 703.298.4836