Home » railML newsgroups » railml.common » [railML3] Strategy of documentation at wiki.railML.org (Impulse for a discussion: how should railML3 be documented?)
[railML3] Strategy of documentation at wiki.railML.org [message #1415] Tue, 06 September 2016 13:08 Go to previous message
Ferri Leberl is currently offline  Ferri Leberl
Messages: 24
Registered: September 2016
Junior Member
Dear Everybody,

As the changes between versions 2.x and 3.x are considered to be big, DI Kolmorgen asked me to present some ideas on how we should deal with these differences in the documentation.

Essentially, there are two poles -- explaining the different versions within the same, existing wiki versus writing a new wiki from scratch -- and there might be some compromise by starting a new wiki, but importing certain existing content.

Besides this question, we ask you for ideas on how to standardize the documentation, and how to integrate UML or XML definitions into wiki pages.

I have enclosed a draft of the alternatives and their pros and cons. It is written in German. If it is required we will make up an English translation.

Thank you in advance for your interest and your ideas.

Yours,
Mag. Ferri Leberl
  • Attachment: impuls.pdf
    (Size: 89.31KB, Downloaded 2583 times)

[Updated on: Tue, 06 September 2016 15:52] by Moderator

Report message to a moderator

 
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Read Message
Previous Topic: To use or not to use? - default values in XSDs
Next Topic: Child elements with one value vs. attributes
Goto Forum:
  


Current Time: Fri Mar 29 12:00:42 CET 2024