• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

preparing the technical specification of the xml file

 
chandrakanth boga
Ranch Hand
Posts: 49
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hello ,

I have to prepare the technical specification of an xml file.
Could you please suggest me how to prepare the specification document by looking in to xml file.



Thanks..
chandu
 
Ulf Dittmer
Rancher
Posts: 42968
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
What do you mean by "technical specification" - a schema? Documentation in general? Something else?
 
chandrakanth boga
Ranch Hand
Posts: 49
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I mean Documentation in general.
 
chandrakanth boga
Ranch Hand
Posts: 49
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I have to prepare the documentation as follows :--

Input Messages
Structure
Example
Example message
<Book id=�41234� numberOfPages=�437�>
<Title>Lawrence of Arabia</Title>
</Book>
Output Messages
Structure
Strutural description.
Example
Example message
<Book id=�41234� numberOfPages=�437�>
<Title>Lawrence of Arabia</Title>
</Book>
Specification
Overview and Purpose

Details
Detailed description of steps
 
Ulf Dittmer
Rancher
Posts: 42968
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I'm not following. If you know what the structure of the documentation should be, what stops you from writing it? You know what the meaning and values of those elements and attributes can be; but we don't.
 
William Brogden
Author and all-around good cowpoke
Rancher
Posts: 13071
6
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Generally speaking, one would expect a DTD and/or a schema for "technical specification" - just as an exercise I copied the posted XML and used XML Spy's DTD generation facility to produce:


XML Spy can also generate schema but they end up too large to post.

Bill
 
chandrakanth boga
Ranch Hand
Posts: 49
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Ulf Dittmer ,

I also dont know what this xml does.
But i need to understand the xml file and prepare the documentation as given in my previous post.These xml files are developed using novell composer.We have around 60 xml files of this type which i need to prepare the documentation.But i dont understand what should i write in the documentation.If one documentation is prepared based on one xml file then i can continue preparing the documentations for the rest of the 60 xml files.
I hope you got my point.
Thanks
chandu
 
chandrakanth boga
Ranch Hand
Posts: 49
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
As these xml services are developed using novell composer and they want to come out of novell and develop these services again.
This documnetation will be handy for the developers who develop these services again.
What will the dtd and schema will help ?
 
Paul Clapham
Sheriff
Posts: 21322
32
Eclipse IDE Firefox Browser MySQL Database
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Originally posted by chandrakanth boga:
But i dont understand what should i write in the documentation.
What you should write in the documentation is whatever your manager says you should write. Ask for a sample of previously-documented formats and use its contents as a basis for what to write.
 
Ulf Dittmer
Rancher
Posts: 42968
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I also dont know what this xml does. But i need to understand the xml file ...

That's what I would start with - find someone who does understand what is going on, and have them explain it to you.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic