Handbuch Frage

[hinz]

Und noch ne Frage
Macht es Sinn, wenn ich hier auch kleinere Ungereimtheiten in den Dokumentationen melde? Ich habe auch beruflich sehr viel mit Dokumentationen zu tun (lesend wie auch schreibend) und es gibt einfach ein paar Sachen, die mich beim Lesen einer Doku nerven (auch wenn ich solche Fehler sehr gerne in den eigenen Dokus einbaue ). Zum Beispiel im Z-Designer Handbuch, Kapitel "Der Zugscriptlauf". Hier ist die Rede von den E/K/F Flags. Da ich das Handbuch schon einmal durchgelesen habe, habe ich zumindest eine Vorstellung wozu diese Flags gut sind. Beim ersten Lesen tauchen hier aber ein paar Fragezeichen auf. Hier wäre vielleicht ein kleiner Hinweis darauf, wozu diese Flags dienen, nützlich. In der Regel wird man das eh überlesen (Motto: wird wohl später erklärt).
Ich will hier keinen Nerven und das Handbuchteam hat bestimmt genügend zu tun (sonst würde ja keine neuen Dokumentatoren gesucht), deswegen die Eingangsfrage.
Mein Gott, was bin ich heut' wieder pingelig

Servus
Heinz

[LotharImKeller]

Hallo Heinz,
Hinweise auf Ungereimtheiten und Fehler (seien es noch so kleine) sind gerne gesehen. Dafür wäre es am Besten, wenn Du den Link zur entsprechenden Handbuch-Seite mitschickst und vielleicht einen Vorschlag machst, inwieweit man den jeweiligen Passus ändern könnte.

Grüße,
Lothar.

[hinz]

Hallo Lothar,

wow, das ging ja schnell.
Okay, ich würde an der Stelle einfach in gekürzter Form das erwähnen was im Abschnitt zu den Flags drin steht:

Der ZugScript-Lauf ist nicht nur für die Zugerzeugung sondern auch für die Zugverknüpfung mittels E/K/F-Flags zuständig.
<neu hinzufügen>
Flags dienen dazu, einen Zug etwas spezielles an einem Bahnsteig ausführen zu lassen.
• E - Name des Zugs ändern
• K - Es kann von vorne und von hinten an einen stehenden Zug gekuppelt werden
• F - Zug flügeln
<ende>

Das ganze ist hier: http://doku.stellwerksim.de/node/107

Und dann gleich noch einer: http://doku.stellwerksim.de/Flags

E - Name des Zugs ändern ändern, in Klammern... <da ist ein ändern zu viel >

Noch eine Anregung dazu: hilfreich wäre es auch, wenn das ganze Handbuch durchnummeriert wäre, soweit ich das sehe ist es das nur in Teilen (wobei der Link natürlich viel schneller zum Ziel führt, aber in der Diskussion wäre ein Nummernschema einfacher).

Servus
Heinz

[LotharImKeller]

Hallo Heinz,
ich habe die Änderungsvorschläge mal notiert. Mal gucken, wann ich dazu komme.

Noch eine Anregung dazu: hilfreich wäre es auch, wenn das ganze Handbuch durchnummeriert wäre, soweit ich das sehe ist es das nur in Teilen (wobei der Link natürlich viel schneller zum Ziel führt, aber in der Diskussion wäre ein Nummernschema einfacher).

Das wird jetzt nicht mehr geändert, da eine völlig neues Handbuch geschrieben wird (mit einem anderen System).

Grüße,
Lothar.

[hinz]

Hallo Lothar,

wenn Du dann schon am ändern bist, hier noch zwei Rechtschreibfehler.

http://doku.stellwerksim.de/Fahrplaneditor

Einen Fahrplan für ein Template zu ertsellen ist auch ganz einfach:
<zeichendreher: erstellen>

Eine Zeilen löschen kann man, indem man die Tatse mit dem Mülleimer vor dem Bahnsteigfeld klickt.
<steht noch im oberen Drittel, gleich zwei Fehler, "Eine Zeile..." und "Taste" >

Das war's jetzt aber für heute - versprochen!

Servus
Heinz