| Documentation concept [message #1018] |
Mon, 23 February 2004 21:55 |
Ulrich Linder
Messages: 28
Registered: July 2003
|
Junior Member |
|
|
Hello,
I worked the last weeks on the RailML infrastructure schema and the
documentation. As result of this work, I'll suggest a new kind of
documentation for all RailML schemas. This will be a three-part
documentation:
1. Internal Schema Documentation:
All elements and attributes are commentated by annotations. A separate
annotation is used for the history.
2. Technical Reference:
The technical reference contains all defined elements, simple and complex
types. It should be generated automatically from the internal schema
documentation. This can be realized i.e. with the feature "generate
documentation" in XMLSpy.
3. Overall plan and coarse structure:
This (handwritten) text describes the main concept and the structure of the
schema. Particular elements and design concepts should be described detailed
on concrete examples.
All documents should be available in english. The overall plan and coarse
structure can be translated in prefered languages.
At the moment I write the overall plan and coarse structure of the
infrastructure schema. I've copied an extract of this (german) document and
the technical reference on my website. An english version will be available
soon.
http://www.linder-rail-consult.de/railml/docs
Feel free to comment by recommendation in the forum or by email.
With best regards
Ulrich Linder
-------------------------------
Dipl.-Ing. Ulrich Linder
Mörchinger Str. 25
D-14169 Berlin
Tel. +49.30.84 72 56 87
Fax. +49.30.84 47 11 56
Email: UlrichLinder(at)linder-rail-consultde
www: http://www.linder-rail-consult.de
|
|
|
|
Members
Search
Help
Login
Home
