Seite 1 von 2

Dokumentation

Verfasst: Mi 29. Jan 2014, 15:23:46
von BorisM
Hallo,

hier möchte ich das Thema Dokumentation mal zur Diskussion stellen. Ein Problem bei der Dokumentation ist, dass eigentlich noch kein sinnvolles Konzept existiert.

StellSi soll langfristig die verschiedensten Bauformen simulieren können, und orientiert sich sehr stark am Vorbild. Daraus entsteht dann natürlich eine relativ große Komplexität der Bedienung, auch weil ja auch betriebliche Punkte (Zugmeldungen etc) beachtet werden müssen.

Die Kernfrage ist daher in meinen Augen: Wie führt man jemand, der von Stellwerken keine Ahnung hat, in das Thema ein, ohne dass er zu sehr mit Informationen überfrachtet wird und dadurch wieder die Lust verliert?

Gleichzeitig muss aber auch jemand, der grundlegend Ahnung hat, sich schnell in eine Bauform einarbeiten können, die er noch nicht kennt, ohne dazu zu viel grundlegende Einführungen lesen zu müssen.

Wenn jemand ein mechanisches Stellwerk bedienen will, das einen ganzen Bahnhof bedient, braucht er ja z.B. nicht die Feinheiten des Bahnhofsblocks kennen. Und wenn ein Stellwerk keine Ausweichanschlußstelle an der Strecke hat, muss er nicht wissen wie er die Awanst bedienen muss. Aber es kann auch sein, dass ein mechanisches Stellwerk über Selbstblock oder eine elektrische Weiche verfügt - wie erfährt er in dem Fall wie er den Bedienen muss?

Und dann kommen ja auch noch irgendwann Störungen dazu.

Mit einer einzigen Anleitung ist es in StellSi nicht getan. Wie organisiert man es, dass der Nutzer genau das findet, was er braucht?

Momentan steht ein Wiki zur Verfügung, in das Dokumentation eingebaut werden kann/sollte. Das ist vermutlich die Lösung, die momentan zeitlich am ehesten zu realisieren ist. Wie strukturiert man aber die Informationen im Wiki richtig, um eine solche Überfrachtung des Lesers zu vermeiden? Die wenigsten werden vor dem ersten Spielen erst mal eine Stunde Anleitung lesen.

Ich denke, dass mittelfristig zumindest ein Teil der Hilfe-Funktionalität in das Programm selber wandern muss, und dem Spieler dabei jeweils die Informationen geben muss, die er in der konkreten Anlage/der konkreten Situation benötigt.

Von daher - her mit den Ideen :-)

Re: Dokumentation

Verfasst: Do 30. Jan 2014, 09:29:46
von Glatzy
Ich denke,das es am Sinnvollsten wäre ,jede Simulation eine kurze Bedienungsanleitung zuzuordnen.
Der Erbauer der Simulation,müßte doch wissen wie er seine Anlage bedient. :roll:

Re: Dokumentation

Verfasst: Do 30. Jan 2014, 20:01:56
von BorisM
Das ist dann aber auch wieder suboptimal, weil die allgemeinen Funktionen des Stellwerks will der Spieler ja nicht bei jedem Stellwerk erneut durchlesen...

Re: Dokumentation

Verfasst: Fr 31. Jan 2014, 09:02:04
von Glatzy
Ich glaube das ich missverstanden worden bin.
Die Allgemeinen Funktionen eines Stellwerks müßten in die Wiki(Mechanisch,Gleisbid,usw.)
Die Bedienungsanleitung des Erbauers,denke ich mir so wie eine örtliche Einweisung.
In der Realität ist es doch auch so,das der Mensch der auf dem Stellwerk mal seinen Dienst machen soll.in der
Ausbildung das Allgemeinwissen der Stellwerke mitbekommt und später für jedes Stellwerk
auf dem er Dienst macht eine persönliche Einweisung vor Ort,über die Besonderheiten dieses Stellwerks.

MfG Glatzy

Re: Dokumentation

Verfasst: Fr 31. Jan 2014, 13:51:51
von BorisM
In der Realität ist es doch auch so,das der Mensch der auf dem Stellwerk mal seinen Dienst machen soll.in der
Ausbildung das Allgemeinwissen der Stellwerke mitbekommt und später für jedes Stellwerk
auf dem er Dienst macht eine persönliche Einweisung vor Ort,über die Besonderheiten dieses Stellwerks.
Ich möchte mit StellSi aber so weit wie möglich auch die Leute erreichen, die von Stellwerken noch keine Ahnung haben. Eine lange Einarbeitungszeit mit der Doku ist abschreckend - nur weil das bei anderen Simulationen so ist, muss das ja nicht heißen, dass es bei uns genauso sein muss.

Gesucht sind deswegen Ideen oder von mir aus auch Visionen - ohne darüber nachzudenken, ob die auch technisch realisierbar sind. Für die Prüfung der technischen Realisierbarkeit sind wir Programmierer dann zuständig :-)

Und nein, das ganze hat nicht die höchste Priorität, und daher werden wir vorerst auf jeden Fall eine provisorische Doku, vermutlich im Wiki, benötigen. Aber auch für die brauchen wir eine sinnvolle Gliederung, die im Idealfall dann auch eine Verwendbarkeit im richtigen Dokusystem ermöglichen sollte.

Re: Dokumentation

Verfasst: Fr 31. Jan 2014, 20:54:00
von Hl13
In der Realität ist es doch auch so,das der Mensch der auf dem Stellwerk mal seinen Dienst machen soll.in der
Ausbildung das Allgemeinwissen der Stellwerke mitbekommt und später für jedes Stellwerk
auf dem er Dienst macht eine persönliche Einweisung vor Ort,über die Besonderheiten dieses Stellwerks.
Beim Lesen davon kommt mir eine Idee:
Schön wäre ja auch so eine Art "Tutorial", bei dem man eingewiesen wird. Man kann ja auch auf einem einfachen Bahnhof / einer Blockstelle / ... ein allgemeines Tuturial machen, in dem die Grundlagen des Eisenbahnbetriebs "spielerisch" gezeigt werden. Zusätzlich dazu können ja im Internet und/oder in einer Hilfefunktion die ganzen Feinheiten des Eisenbahnbetriebs (Sperrfahrten, Nebenfahrzeuge, ...) vorgestellt werden. Dort kann man ja auch den Normalbetrieb erklären. Die örtlichen Besonderheiten (z.B. Mitwirktasten bei S&H1912, ...) könnten dann im Stellwerksfenster beschrieben werden. Auch wäre es toll, wenn nötig für jeden Bahnhof ein eigenes Tutorial erstellen zu können (als Erbauer), wo dann die örtlichen Besonderheiten erklärt werden.
Falls gewünscht, kann ich bei der Erstellung der Grundlagen- und Feinheiten-Doku (vor allem für NE, da ich die FV NE in einer relativ aktuellen Fassung habe) behilflich sein.

Grüße,
Hl13

Re: Dokumentation

Verfasst: So 2. Feb 2014, 00:19:39
von BorisM
Hl13 hat geschrieben: Schön wäre ja auch so eine Art "Tutorial", bei dem man eingewiesen wird. Man kann ja auch auf einem einfachen Bahnhof / einer Blockstelle / ... ein allgemeines Tuturial machen, in dem die Grundlagen des Eisenbahnbetriebs "spielerisch" gezeigt werden.
Das klingt schon mal nicht schlecht.
Zusätzlich dazu können ja im Internet und/oder in einer Hilfefunktion die ganzen Feinheiten des Eisenbahnbetriebs (Sperrfahrten, Nebenfahrzeuge, ...) vorgestellt werden. Dort kann man ja auch den Normalbetrieb erklären.
Ja genau. Effektiv sehe ich zwei Unterscheidungen bei den Inhalten.
Einmal das was:
  • Bahnbetrieb allgemein
  • Bedienung des Programms
  • Bauformen grob (Mech/Emech/Drucktaste)
  • Bauformen speziell (suh1901, suh1907, suh1912, e43, ...)
  • Spezialitäten in einzelnen Stellwerken
Zum anderen die Schwierigkeitsgrade:
  • Grundlagen im Regelbetrieb - für jedes Stellwerk
  • Speziellere Funktionen im Regelbetrieb - nur für bestimmte Stellwerke (z.B. Bahnhofsblock, Mitwirktasten, ...
  • Störungen - für jedes Stellwerk
  • Störungen - nur in bestimmten Stellwerken
Vermutlich ist die Liste nicht vollständig.

Es muss nicht zwangsläufig für alle Kombinationen die selbe Realisierung gewählt werden. Bahnbetrieb allgemein im Regelbetrieb und Bedienung des Programms kann denke ich durchaus in Form eines Handbuchs gestaltet sein. Störungen dagegen ist in Form eines Handbuchs vielleicht nicht so sinnvoll. Hier wäre es wohl sinnvoller, die Hilfe direkt im Programm zu hinterlegen und mit der jeweiligen Störung zu verknüpfen.

Bei den Bedienungsanleitungen für die Stellwerksbauformen haben wir halt auch so was ähnliches - einerseits muss man mal wissen was ein E-Mech ist, wie man die Hebel bewegt etc. Aber dann gibt es halt viele Varianten - Mitwirktaste/Fahrstraßenauflösetaste, Bahnhofsblock, Felderblock, Relaisblock mit Tasten oder mit Blockhebeln, Selbstblock, ...

Hier kann man es in meinen Augen dem Spieler nicht überlassen, sich selbst zusammenzusuchen was er braucht - er wäre hier in meinen Augen hoffnungslos überfordert.
Die örtlichen Besonderheiten (z.B. Mitwirktasten bei S&H1912, ...) könnten dann im Stellwerksfenster beschrieben werden.
Ja, das klingt nicht verkehrt. Die Frage ist nur, wie man das realisiert. Es kann natürlich jeder Erbauer selber irgendwas zusammenschreiben, aber dann weiß man nicht, ob es vollständig ist, außerdem besteht die Gefahr, dass der Spieler überfrachtet wird mit Infomrationen, die er nicht braucht.

Möglicherweise könnte man das auch automatisieren - es ist ja bekannt, was so alles in dem Stellwerk verbaut ist (anhand der Relaisgruppen/Bedienelemente), man könnte also diese Hilfe ggf. auch automatisch zusammenstellen - und sich evtl. auch merken, welche Einträge der Spieler schon gelesen hat und dann nicht mehr anzeigen.
Auch wäre es toll, wenn nötig für jeden Bahnhof ein eigenes Tutorial erstellen zu können (als Erbauer), wo dann die örtlichen Besonderheiten erklärt werden.
Ich glaube das ist dann doch zu aufwendig auf Dauer - und auch nicht wirklich zielführend, weil zu unübersichtlich?
Falls gewünscht, kann ich bei der Erstellung der Grundlagen- und Feinheiten-Doku (vor allem für NE, da ich die FV NE in einer relativ aktuellen Fassung habe) behilflich sein.
FV-NE ist auch wieder ein Stichwort - das ist sicherlich nicht unwichtig, aber der Fokus von StellSi wird (vorerst) ja doch mehr auf der 408 liegen, bzw. irgendwann auch der V2 / V3 in Österreich, bzw. der schweizer Fahrdienstvorschrift. Man muss aber auch bedenken, dass andere Vorschriften durch uns Programmierer erst ermöglicht werden müssen - momentan ist alles auf die 408 ausgelegt und entsprechend fest einprogrammiert, Konzepte, das zu ändern, müssten erst entwickelt werden. Das wird also wohl erst in ein paar Jahren ein Thema werden. Letztendlich gilt das auch für die FV-NE.

Aber wir können ja trotzdem mal in die Zukunft schauen - auch die Frage, wie man die verschiedenen Vorschriften für den Nutzer einfach auffindbar und übersichtlich in die Dokumentation einbaut, muss natürlich geklärt werden.

Das Problem aktuell ist: Es gibt von vielen Angebote zur Mitarbeit an der Doku - aber es gibt kein Konzept, und niemanden, der es koordiniert. Zuerst muss in meinen Augen die Struktur der Doku geklärt werden, und auch die Abläufe.

Generell möchte ich keine so strenge Hierarchie wie z.B. bei STS - es soll niemand betteln müssen um Mitarbeiten zu dürfen, und es soll sich auch keiner als "Chef" aufspielen. Aber irgendwie muss das ganze dann doch koordiniert werden denke ich - und da habe ich einfach nicht die Zeit (und auch ehrlich gesagt keine sonderliche Lust :-) ) das zu übernehmen.

Re: Dokumentation

Verfasst: So 2. Feb 2014, 12:53:47
von Hl13
BorisM hat geschrieben: Möglicherweise könnte man das auch automatisieren - es ist ja bekannt, was so alles in dem Stellwerk verbaut ist (anhand der Relaisgruppen/Bedienelemente), man könnte also diese Hilfe ggf. auch automatisch zusammenstellen - und sich evtl. auch merken, welche Einträge der Spieler schon gelesen hat und dann nicht mehr anzeigen.
Für die Regelfunktionalität wäre das schon eine Idee, aber man müsste das dann auch "ausschalten" oder überschreiben können, falls beim Stellwerk dann etwas von der Regel abweicht (und man nicht unbedingt Lust hat, eine eigene Relaisgruppe dafür zu bauen ;) ). Sonst wird die Sache ziemlich komplex, denn ein grüner Fahrstraßenhebel (oder eine Doppelzustimmungsgruppe) beim S&H 1912 weist nicht unbedingt auf einen Bahnhofsblock hin (siehe z.B. Industrieumschlagbahnhof).
BorisM hat geschrieben:
Auch wäre es toll, wenn nötig für jeden Bahnhof ein eigenes Tutorial erstellen zu können (als Erbauer), wo dann die örtlichen Besonderheiten erklärt werden.
Ich glaube das ist dann doch zu aufwendig auf Dauer - und auch nicht wirklich zielführend, weil zu unübersichtlich?
Für kleine Bahnhöfe ist das ja auch nicht notwendig, aber auf großen Bahnhöfen finde ich so etwas schon sinnvoll, da man den Bediener dann "sanft" in die Fahrwegprüfbezirke (und welche Weiche nun von welchem Stellwerk gesteuert wird, ...) und den Gesamtablauf einführen kann. Wenn man sowieso ein Tutorial zum Eisenbahnbetrieb macht, kann man ja gleich die Vorraussetzungen dafür mit schaffen. Es muss ja auch nicht gleich ein graphischer Editor sein, eine Datei mit einem Texteditor zu bearbeiten wäre denke ich dafür ausreichend.

Re: Dokumentation

Verfasst: So 2. Feb 2014, 19:40:26
von BorisM
Hl13 hat geschrieben: Für die Regelfunktionalität wäre das schon eine Idee, aber man müsste das dann auch "ausschalten" oder überschreiben können, falls beim Stellwerk dann etwas von der Regel abweicht (und man nicht unbedingt Lust hat, eine eigene Relaisgruppe dafür zu bauen ;) ). Sonst wird die Sache ziemlich komplex, denn ein grüner Fahrstraßenhebel (oder eine Doppelzustimmungsgruppe) beim S&H 1912 weist nicht unbedingt auf einen Bahnhofsblock hin (siehe z.B. Industrieumschlagbahnhof).
Ich würde auch eher nach den Relaisgruppen gehen - eine Zustimmungsgruppe deutet dann doch meist darauf hin, dass eine Zustimmung verbaut wurde :-)

Aber stimmt schon, z.B. beim Streckenblock gibt es (zumindest momentan) eine Relaisgruppe sowohl für Relaisblock als auch für Felderblock - was natürlich ein Unterschied ist. Ggf. werden das aber auch noch zwei getrennte Relaisgruppen - mal sehen.
Für kleine Bahnhöfe ist das ja auch nicht notwendig, aber auf großen Bahnhöfen finde ich so etwas schon sinnvoll, da man den Bediener dann "sanft" in die Fahrwegprüfbezirke (und welche Weiche nun von welchem Stellwerk gesteuert wird, ...) und den Gesamtablauf einführen kann. Wenn man sowieso ein Tutorial zum Eisenbahnbetrieb macht, kann man ja gleich die Vorraussetzungen dafür mit schaffen. Es muss ja auch nicht gleich ein graphischer Editor sein, eine Datei mit einem Texteditor zu bearbeiten wäre denke ich dafür ausreichend.
Ja klar, solche Informationen müssen natürlich gegeben werden, aber das ist ja etwas anderes als ein Tutorial?

Generell würde ich das ganze per HTML machen, wie man den Editor dafür bereitstellt muss natürlich noch geklärt werden.

Die Fahrwegprüfbezirke sollten denke ich in die Außenanlage eingetragen werden.

Re: Dokumentation

Verfasst: Di 4. Feb 2014, 23:08:21
von SteenkenJ
Meiner Meinung nach sollte man die Bedienungsanleitung so einfach wie möglich halten, da der Normalanwender wohl eigentlich nur wissen möchte was er wann in welcher Reihenfolge zu machen hat. Anhaltspunkt wäre hier durchaus die Dienstvorschrift des Vorbildes, welche zumindest für die Ausführung E43 bereits zu einem großen Teil als HTML-Text vorhanden ist. Wer tiefer einsteigen möchte kommt ohnehin nicht um die technischen Beschreibungen herum bzw. kennt den inneren Aufbau "seiner" Variante.