Schreibstil der Doku

Alles zu Zusi-Performance, Frameraten, ruckelnden Bildern, Grafik, Treibern usw.
Nachricht
Autor
Benutzeravatar
Br.424
Beiträge: 135
Registriert: 17.08.2004 10:31:58
Wohnort: Obernkirchen

Re: Schreibstil der Doku

#21 Beitrag von Br.424 »

Hi,
Gibt es dazu eine belastbare Quelle? Der Hersteller (in diesem Fall von Software) steht für ein mangelfreies, d.h. spezifikationskonformes Softwareprodukt gerade. Soweit einverstanden. Wo gibt es eindeutige Regelungen zu den Anforderungen an die Dokumentation? Du bist ja vom Fach, daher hoffe ich, daß Du hier meine - auch über den Zusi-Tellerrand hinausgehende - Neugierde befriedigen kannst.
Da ich ebenfalls vom Fach bin: Das steht im Produktsicherheitsgesetz.

Viele Grüße
Henning
Zuletzt geändert von Br.424 am 10.01.2014 17:02:12, insgesamt 2-mal geändert.

Benutzeravatar
Carsten Hölscher
Administrator
Beiträge: 33436
Registriert: 04.07.2002 00:14:42
Wohnort: Braunschweig
Kontaktdaten:

Re: Schreibstil der Doku

#22 Beitrag von Carsten Hölscher »

Ein vielleicht nicht immer perfekter Schreibstil dürfte aber von einer schadensersatzpflichtigen Angelegeheit sehr weit entfernt sein. Da muss auch mal ein bißchen die Kirche im Dorf bleiben.

Carsten

Benutzeravatar
Michael Springer
Beiträge: 2930
Registriert: 24.06.2002 16:22:44
Wohnort: Schwäbisch Gmünd

Re: Schreibstil der Doku

#23 Beitrag von Michael Springer »

Schlechter Schreibstil kann ein Mangel sein, muss aber nicht. Wenn ich z. B. aufgrund des schlechten Schreibstils ein Regal nicht zusammengebaut komme, ist es ein Sachmangel. Siehe BGB §434 (2). Oder ich kriege eine versprochene Funktionen in einem Programm nicht zum Laufen.

Wir werden sicherlich eine Lösung für die Zusi3-Doku in welcher Form und wann auch immer finden...

Benutzeravatar
Michael Springer
Beiträge: 2930
Registriert: 24.06.2002 16:22:44
Wohnort: Schwäbisch Gmünd

Re: Schreibstil der Doku

#24 Beitrag von Michael Springer »

Ob Anleitungen oder der Schreibstil gut oder schlecht ist, ist immer ein persönliches Empfinden. Wie ich weiter oben schon geschrieben habe, ist es deshalb so schwer die Qualität einer Anleitung valide zu bestimmen. Frag 10 Leute und du kriegst 15 Meinungen wie den Leuten die Anleitung gefällt.

Wenn man schon drauf guckt, das Wagen X nur 300 Dreiecke haben, warum schafft man dann nicht auch nicht Regeln oder eine Messlatte für die Anleitung? Jeder Autor täte sich damit leichter.


Edit: Irgendwie ist ein Beitrag von Johannes verschwunden...
Zuletzt geändert von Michael Springer am 10.01.2014 17:24:21, insgesamt 1-mal geändert.

Benutzeravatar
Johannes
Beiträge: 3202
Registriert: 14.03.2009 22:36:06
Aktuelle Projekte: Zusitools (http://git.io/zusitools)

Re: Schreibstil der Doku

#25 Beitrag von Johannes »

Michael Springer hat geschrieben:Edit: Irgendwie ist ein Beitrag von Johannes verschwunden...
Ich hatte ihn kurz nach dem Schreiben geloescht, weil ich mir nicht mehr sicher war, ob sich das "schlecht" oben jetzt auf die Zusi-Anleitung bezogen hat oder nicht.

Damit keine Verwirrung entsteht: Ich hatte mich ueber die Verwendung des Adjektivs "schlecht" im Zusammenhang mit der Zusi-Doku beschwert. Die ist zwar etwas technisch, aber alles andere als schlecht geschrieben und fuer die Zielgruppe auch m.E. gut zu verstehen.

Gruesse
Johannes

Benutzeravatar
Michael_Poschmann
Beiträge: 19880
Registriert: 05.11.2001 15:11:18
Aktuelle Projekte: Modul Menden (Sauerland)
Wohnort: Str.Km "1,6" der Oberen Ruhrtalbahn (DB-Str. 2550)

Re: Schreibstil der Doku

#26 Beitrag von Michael_Poschmann »

Hallo Henning,
Br.424 hat geschrieben:Das steht im Produktsicherheitsgesetz.
hast Du aus dem Ärmel ein paar genauere Hinweise, wie genau eine Dokumentation beschaffen sein muss und was eine "gute" von einer "unzureichenden" Dokumentation unterscheidet?

Weitere spannende Fragen, *muss* eine Software gemäß irgendwelcher gesetzlicher Regelungen zwingend mit einer Dokumentation ausgeliefert werden?

Was passiert, wenn ein Werkzeug, das für den kreativen Bau von Dingen verwendet wird (hier z.B. Strecken, Lokmodelle, etc.), nicht das gewünschte Ergebnis liefert, weil der Nutzer möglicherweise am Umgang mit der Materie scheitert? Wie weist man hier die Ursache zu? Wie klärt man die Frage, ob ein Sachmangel in der Dokumentation ursächlich ist oder vielmehr mangelnde Qualifikation oder Fähigkeit des Nutzers?

Zugegeben ein paar sehr theoretische Ansätze, sicherlich fern der konkreten Zusi-Thematik, aber mich interessiert das tatsächlich.

Gespannte Grüße
Michael

edit: Rechtschreibung
Zuletzt geändert von Michael_Poschmann am 10.01.2014 18:02:56, insgesamt 2-mal geändert.

AndiS
Beiträge: 379
Registriert: 20.09.2011 13:26:52
Wohnort: Wien

Re: Schreibstil der Doku

#27 Beitrag von AndiS »

Also als Ausländer bekommt man das Gefühl, daß ein paar Jahre unverschämte Abmahnaktionen von geldgierigen Rechtsanwälten die Gesamtbevölkerung in einen seltsamen Zustand versetzen. Also wenn da irgend jemand zur juristischen Tat schreitet, dann muß er Deutscher sein, und Carsten auch, was ja der Fall ist. Ansonsten gäbe es nur 100% Lachsalven.

Ich kenne da ein Simulationsprodukt, daß phasenweise das Wort Simulation aus dem Namen nahm, aber nicht wegen rechtlicher Bedenken, sondern - wenn überhaupt - weil das Forumsgewinsel so laut war. Die Dokumentation enthält seit 2007 handfeste Fehler und den Einsatz bestimmter Features verhindern und niemand ist auf die Idee gekommen, den Hersteller zu klagen. Ganz im Gegenteil, das Ding geht weg wie die warmen Semmeln.

Selbst wenn es einschlägige Urteile gibt, muß man vorsichtig sein bei der Verallgemeinerung. Wenn IKEA ein Regal verkauft, dann muß es auch von gerade erst volljährigen oder auch sehr alten Menschen zusammengebaut werden können, mit einem IQ der knapp über der Grenze für die Geschäftsfähigkeit liegt.

Eine Eisenbahnsimulation, die in der Vermarktung darauf hinweist, daß sie eine anspruchsvolle Freizeittätigkeit für technisch Interessierte biete, muß mit der Dokumentation nur diese Menschen befriedigen. Und ich habe keine Leseprobe zu Gesicht bekommen, die diesem Anspruch nicht Genüge getan hätte.

Benutzeravatar
Michael_Poschmann
Beiträge: 19880
Registriert: 05.11.2001 15:11:18
Aktuelle Projekte: Modul Menden (Sauerland)
Wohnort: Str.Km "1,6" der Oberen Ruhrtalbahn (DB-Str. 2550)

Re: Schreibstil der Doku

#28 Beitrag von Michael_Poschmann »

Andi, ich bewundere Deine südländische Gelassenheit. Die ist uns am Polarkreis leider bisweilen fremd. 8) Vielleicht sollte Carsten in der Doku an geeigneter Stelle das Wort "Meilenpfosten" unterbringen. Und dann in Ruhe auf die drohene Prozesslawine warten.

Grüße
Michael

F(R)S-Bauer
Beiträge: 6289
Registriert: 09.11.2002 02:00:47

Re: Schreibstil der Doku

#29 Beitrag von F(R)S-Bauer »

AndiS hat geschrieben:Also als Ausländer bekommt man das Gefühl, daß ein paar Jahre unverschämte Abmahnaktionen von geldgierigen Rechtsanwälten die Gesamtbevölkerung in einen seltsamen Zustand versetzen. ...
Das ist Genetisch...das Blockwartgen etc.

Wenn einiges was hier in D gelaufen ist in Frankreich passieren würde...Das Parlament hätte in Flammen gestanden...in D ruft man "weiter so, Zugabe!"

mfg

Ralf
Verstehe die IT, heute: IoF -> Internet over Fax, eine Deutsch Erfindung...

Benutzeravatar
David Seemayer
Beiträge: 1470
Registriert: 12.08.2002 21:45:45
Wohnort: Vöcklabruck
Kontaktdaten:

Re: Schreibstil der Doku

#30 Beitrag von David Seemayer »

OT:
Michael_Poschmann hat geschrieben:Andi, ich bewundere Deine südländische Gelassenheit.
Da sich der Beginn des 1. WK heuer zum hundertsten Mal jährt:
Ein deutscher und ein österreichischer Soldat machen Meldung bei ihrem Vorgesetzten über die Lage an der Front.
Der Deutsche: "Herr Hauptmann, die Lage ist ernst, aber nicht hoffnungslos!"
Der Österreicher: "Herr Hauptmann, die Lage ist hoffnungslos, aber nicht ernst!"
http://www.maurerbock.com" target="_blank

Ein Triebkopf kommt selten allein!

AndiS
Beiträge: 379
Registriert: 20.09.2011 13:26:52
Wohnort: Wien

Re: Schreibstil der Doku

#31 Beitrag von AndiS »

Noch ein paar Gedanken aus dem sonnigen Süden:

1.) Bei uns in A wird allen Berufsfotografen eine Haftpflichtversicherung aufgezwungen, die sie im Falle ungerechtfertigter Kundenansprüche schützen soll. Bei Fotos ist die Frage, ob das gelieferte Produkt den Wünschen des Kunden entspricht, ja auch nicht ohne. In D gibt es vielleicht solche Versicherungen auch ohne Zwang.


2.) In der Erstausgabe des Kuju Railsimulators waren wesentliche Tools nicht dabei. Die gab es als Graits-Download. Grund war nicht die Angst vor den Rechtsanwälten, sondern die Ansicht von Electronic Arts (damals Vertriebspartner), daß EA-Kunden zu dumm sind zum Modellbau.

Mit diesem Vertriebsmodell ist man gegen dumme Forderungen gefeit, wenn die Bewerbung des Fahrsimulators keinen Hinweis auf den Streckenbau enthält. Für letzteren braucht man bei Zusi, wie ich hörte, einen PhD in Rocket Science. Und wenn ich mir anschaue, wieviele am Gleislegen im Railsimulator gescheitert sind, krieg ich den Polarkreis Blues.

Wirklich helfen können da nur klar fokussierte Tutorials, auf einem übersichtlichen Website angeboten, am Besten in Text- und Videoform, auf die im Forum gebetsmühlenartig hingewiesen wird.


3.) Wirklich gut finde ich Carstens Hinweis bei Zusi 2, man möge doch bitte zuerst die Gratisdemo ausprobieren und sich erst danach zum Kauf entschließen. Wenn Zusi 3.0 nur online vertrieben wird, dann könnte man ins Bestellformular so Sätze einbauen wie "Ich habe die Demo evaluiert und fühle mich von grafischer Gestaltung und Schwierigkeitsgrad angesprochen." Mit Hackerl daneben wie bei "Ich habe die ABG gelesen."

Viele Firmen verfolgen überhaupt das "Try and Buy"-Prinzip, bei dem die Demo durch Freischalten zum vollwertigen Programm wird. Ich würde es zweiteilen: Demo-Download, Erwerben des Freischaltecodes, Download des Rests. Das spart zumindest Bandbreite auf beiden Seiten. In diesem Setting hat man eine gewisse Garantie, daß sich die Leute mit der Demo auseinandergesetzt haben, ohne den von mir erdachten Satz hinschreiben zu müssen.


4.) Es geht bei der Verständlichkeit von Dokumentation nicht nur um den Satzbau. Es geht auch darum, was dort steht und was nicht. Und um die Anleitung des Lesers durch die 500 Seiten. "How to read this document" steht heutzutage oft am Anfang von umfangreicheren Texten. Auch "How to avoid reading this document", gefolgt von einer Aufzählung externer Tutorials.

Der Fahrschulmodus in Zusi deckt schon sehr viel ab. Besser geht es m.E. betreffend Fahren gar nicht mehr. Beim Streckenbau kann ich mir eine Serie dieser Art vorstellen: "Mein erstes Haus in Zusi", "Mein erstes Steckenmodul", "Mein erster Fahrplan", etc. Teilweise gibt es dieses Material schon. Für den Medienkonsumenten des 21. Jahrhunderts könnte man es auch noch in direkt-klickbare Häppchen auf einer Übersichts(web)seite mit Bildchen zusammenstellen.

Teilweise sollte man es auch echt billig geben, auch wenn es allen Zusi-Fans die Haare aufstellt wegen der ignorierten Feinheiten.

Beispiel 1: Die Tatsache, daß Zusi Texturen nicht erzwingt, ermöglicht die Erstellung eines ersten Häuschens in Null Komma Nix. Wenn man die Leute gleich von Anfang an dazu erzieht, das Kellergeschoß bis 2 m unter 0 auszuziehen, dann kann man sich die Nummer mit der Bodenplatte sparen und das Haus schwebt auch am Hang nicht. Nicht elegant, aber deppensicher.

Beispiel 2: Die diversen Assistenten in Zusi ermöglichen durchaus den zügigen Streckenbau, wenn einem alle Defaults recht sind (und man die Landschaftsausgestaltung auf später verschiebt). Es gibt unglaublich viele Menschen, der Glück in verlegten Streckenkilometern zu messen ist. Die loben Zusi über den grünen Klee, wenn man ihnen einen Ruck-Zuck-Guide mit folgendem Inhalt gibt: Gleise abzeichnen von Google Earth im 2D Editor; Defaultbahnkörper automatisch generiert daraus (wo ist der Button für die Ausnahmewerte damit die Warnungen wegen Schlampereien verschwinden?); SRTM-DEM importieren; das Nötigste über die Signalisierung; das Nötigste über die Fahrplanerstellung. Juhu, der Zug fährt, Zusi ist leicht, Zusi ist super.

Tutorials von Menschen ohne Naheverhältnis zur Entwicklung oder Vorläuferprodukten sind für Anfänger oft klarer verständlich, weil sie den distanzierten Blickwinkel der meisten Neulinge teilen. Das ist natürlich keine Kritik an den vorhandenen Tutorials, sondern eine Ermunterung, auf die Entstehung von Tutorials nach der Release von 3.0 zu setzen. Ich muß auch aus meiner Erfahrung mit Blender und mit Railworks sagen, daß Tutorials auch durch ihre Vielfalt das Ziel erreichen. D.h. ein und dieselbe Funktionalität wird von verschiedenen Personen mit unterschiedlicher Ausrichtung beschrieben, und jeden erreicht eine andere Betrachtungsweise, je nach persönlichem Fokus und Vorwissen.

Benutzeravatar
Carsten Hölscher
Administrator
Beiträge: 33436
Registriert: 04.07.2002 00:14:42
Wohnort: Braunschweig
Kontaktdaten:

Re: Schreibstil der Doku

#32 Beitrag von Carsten Hölscher »

Ich glaub so schlecht steht das bisher dazu erstellte nicht da. Michael Poschmann hat ein umfangreiches Kapitel nur zum Streckenbau als Tutorial verfaßt, das es zusätzlich zur normalen Editor-Doku gibt. Die Dateien aus den Baustadien gibt es auch dazu. Also sozusagen das alte Zusi 2-Tutorial massiv aufgepimpt und auf eine reale Strecke bezogen.

Carsten

BorisM
Beiträge: 303
Registriert: 10.08.2008 01:57:31
Aktuelle Projekte: Universeller Stellwerksimulator
Kontaktdaten:

Re: Schreibstil der Doku

#33 Beitrag von BorisM »

AndiS: Bist Du Dir sicher dass es hier um deutsches Recht geht, und nicht eher um Ängste, die angesichts kuriosester Klagen in den USA auf Deutschland übertragen werden?

Die Angst verklagt zu werden, weil ein Editor mitgeliefert wird, der in der Produktbeschreibung nicht enthalten war, klingt schon etwas seltsam...

Antworten