Wie schreibt man eine Bedienungsanleitung?

Sprachen Deutsche Sprache
1

Hallo Wissende,

speziell im Excelbrett, aber auch in anderen Brettern, taucht das Problem recht häufig auf.
Das Problem ist, wenn Anfrager beim Zeigen von Tabellenblattausschnitten nicht den pre-Tag benutzen so wird dieser Tabellenblattausschnitt unleserlich.
Nachfolgend habe ich mal ein kleines Beispiel gebracht.

Okay, dann weise ich die Anfrager auf FAQ:30 und/oder FAQ:3090 hin.

Leider klappt das nicht immer, manche können auch nach Durchlesen der FAQ:3090 nicht den pre-Tag benutzen da sie irgednwas nicht verstanden haben.
Was genau war leider noch nie durch Nachfrage herauszukriegen:frowning:

Leider sind Jessica, die FAQ-Betreuerin und ich schon gewissermaßen zu überqualifiziert um da im Text der FAQ zu sehen wo es bei ähem Ungeübten hängen könnte beim Verständnis.

Deshalb ist meine Hoffnung, daß hier Leute sind, die auch Null Ahnung haben was ein Pre-Tag ist, sich die FAQ:3090 durchlesen und mitteilen,
am besten gleich mit ihren Worten, was da stehen sollte daß man das besser verstehen kann.

Danke für das Interesse
Gruß
Reinhard

OHNE pre-Tag:
A B C D
1 Grund Montag Dienstag Mittwoch
2 Brot 10 € 8 €
3 Milch 6 €
4 Honig 5 €

MIT pre-Tag:

 A B C D
1 Grund Montag Dienstag Mittwoch
2 Brot 10 € 8 €
3 Milch 6 €
4 Honig 5 €
2

Hallo Reinhard,

Dazu muss man so intelligent sein, dass man sich Dumm stellen kann und es braucht Phantasie um auf dumme Ideen zu kommen.

Damit kann man dann das Grundgerüst erstellen.

Dann schnappt man sich eine unbeteiligte Person, z.B. die Putzfrau, setzt sie vor das Gerät, drückt ihr die Anleitung in die Hände, sagt: „Nu mach mal“ und schaut zu.

Dann stellt man fest, dass man gar nicht so viel Phantasie hat, wie man dachte und muss das Ding überarbeiten…

MfG Peter(TOO)

3

Hallo, Reinhard,
dein unermüdliches Bemühen um die Darstellung von Excel sei an dieser Stelle einmal lobend hervorgehoben.

In der FAQ allerdings krankt das Beispiel daran, dass die Eingabe in der zweiten Zeile naturgemäß den einleitenden TAB unterdrückt. Daher wird an dieser Stelle nicht so ganz klar, wo der Hinkefuß liegt.

Vielleicht sollte man die zweite Zeile mit einem (Tab) einleiten.

Gruß
Eckard

4

Hallo Eckard,

dein unermüdliches Bemühen um die Darstellung von Excel sei an
dieser Stelle einmal lobend hervorgehoben.

danke dir. Die FAQ:2363 habe ich gern gebastelt und wenn ich mal Zeit und Lust habe verbessere ich sie so daß auch Boris becker damit klarkommt :smile:)

Und ja, ich mag Excel, und um Anfragern helfen zu können müssen sie die Möglichkeit haben ihr Problem darzustellen. Dafür kämpfe ich.

In meinem kleinen Beispiel sieht man ja wohl was ich meine.

Und ich wünsche mir halt nur daß wenn jemand anfragt, und ich sehe es ja im Quellcode, nahezu alle benutzen Einrückungen durch Leerzeichen um etwas darzustellen, das ist halt weg ohne pre-Tag, daß ich/andere ihnen nur sagen müssen, schaut in die FAQxyz und benutzt den Pre-tag.

Und das dann keine Rückmeldung kommt, Hä, wie, watt usw. :frowning:

Ich glaube inzwischen Jesssica kann das Wort „pre-Tag“ nicht mehr hören *kicher*
Und mich nervt das Thema auch schon.

Die letzten Tage gab es da kein Vorkommnis, aber vor 12 tagen waren gleich 3 Kanditaten da die FAQ:3090 nicht kapiert haben.

Vorgestern war jmd. hier der meinen Hinweis auf FAQ:2861 nicht umsetzen konnte um eine Datei hochzuladen.

Ich bin da ratlos, was zu tun wäre.

@Peter, ich hoffte hier deutsprachige Putzfrauen zu finden die den FAQ-Text besser formulieren könnten*gg*

In der FAQ allerdings krankt das Beispiel daran, dass die
Eingabe in der zweiten Zeile naturgemäß den einleitenden TAB
unterdrückt. Daher wird an dieser Stelle nicht so ganz klar,
wo der Hinkefuß liegt.

Vielleicht sollte man die zweite Zeile mit einem (Tab)
einleiten.

Ich habe Jessica auf diese Anfrage von mir aufmerksam gemacht, sie wird mitlesen.

Gruß
Reinhard

5

Hallo Reinhard,

Hier meine ersten Kommentare zum FAQ:3090 :

An den Anfang gehört eine Darstellung des Problem. Es sollte deutlich darauf hingewiesen werden, dass das Problem durch die Proportionalschrift und den automatischen Zeilenumbruch entsteht. Am besten mit einem schönen Negativbeispiel (das dann später mit pre verbessert wird).

Dann muss ein Hinweis auf FAQ:30 und/oder eine ganz einfache Erklärung was ein Tag ist, vielleicht anhand des b-Tags. Einfach mit Tür ins Haus zu platzen „Mit dem Tag…“ ist nicht so gut.

Sätze wie Innerhalb des Tags sind Formatierungs-Tags (vgl. FAQ:3084) erlaubt. verwirren hier nur. Da muss sogar ich alter Informatik-Hase kurz nachdenken. Gemeint ist wahrscheinlich, dass in dem von pre und /pre eingeschlossenen Text andere Tags, z.B. zur Hervorhebung von Text zugelassen sind. Ich würde das an dieser Stelle weglassen und ganz am Ende des Artikels unter „Fortgeschrittene Anwendung“ erwähnen.

Ein Beispiel mit einer einfachen Tabelle wäre besser als mit VBA-Code, so wie das Beispiel in deinem vorliegenden Posting, sogar noch einfacher.

Zu prehtml muss auf jeden Fall auch ein Beispiel hinzu.

Ich bin heute Abend nicht zu Hause, sonst hätte ich dir eine ausführlichere Antwort geschrieben. Verzeih daher meine etwas chaotischen Einlassungen.

Grüße
Rainer

6

Hallo Rainer,

An den Anfang gehört eine Darstellung des Problem. Es sollte
deutlich darauf hingewiesen werden, dass das Problem durch die
Proportionalschrift und den automatischen Zeilenumbruch
entsteht.

? Das Problem besteht darin daß der Parser von w-w-w, also der Textfilter der abgeschickte Beiträge filtert mehrfach Leerzeichen rauswirft.

Dann muss ein Hinweis auf FAQ:30 und/oder eine ganz einfache
Erklärung was ein Tag ist, vielleicht anhand des b-Tags.
Einfach mit Tür ins Haus zu platzen „Mit dem Tag…“ ist
nicht so gut.

Sätze wie Innerhalb des Tags sind Formatierungs-Tags (vgl.
FAQ:3084) erlaubt. verwirren hier nur. Da muss sogar ich
alter Informatik-Hase kurz nachdenken. Gemeint ist
wahrscheinlich, dass in dem von pre und /pre eingeschlossenen
Text andere Tags, z.B. zur Hervorhebung von Text zugelassen
sind. Ich würde das an dieser Stelle weglassen und ganz am
Ende des Artikels unter „Fortgeschrittene Anwendung“ erwähnen.

Gute Idee.

Ein Beispiel mit einer einfachen Tabelle wäre besser als mit
VBA-Code, so wie das Beispiel in deinem vorliegenden Posting,
sogar noch einfacher.

Wird geändert.

Zu prehtml muss auf jeden Fall auch ein Beispiel hinzu.

Okay, welche Tags man jetzt als Beispiele nimmt muß man auswählen.
Wihctig ist daß das Prinzip rüberkommt, also vor/oberhalb des zu formatierenden Textes den Namen des tags in eckigen Klammern und nach/unterhalb des Textes das Gleiche mit einem Schrägstrich davor.
Und dies dann durch Beispiele aufzeigen.

Ich bin heute Abend nicht zu Hause, sonst hätte ich dir eine
ausführlichere Antwort geschrieben. Verzeih daher meine etwas
chaotischen Einlassungen.

Mir völlig gleich warum du dich wo rumtreibst :smile: Das Thema nervt mich und weil ich damit Jessica nerve, sie auch schon so lange, wir haben Zeit und warten sehr gerne auf deine ausführlichen Einlassungen :smile:
Ich und Jessica freuen uns über jedwede Unterstützung um endlich mal das Thema ad acta legen zu können.

@Jessica, alle meine Äußerungen besagen natürlich keinesfalls daß ich bestimme oder weiß was du genau über den Pre-tag denkst. Ich mutmaße nur, du könntest mir ggfs. zustimmen.

Danke ^ Gruß
Reinhard

7

Hallo Jessica und Reinhard,

An den Anfang gehört eine Darstellung des Problem. Es sollte
deutlich darauf hingewiesen werden, dass das Problem durch die
Proportionalschrift und den automatischen Zeilenumbruch
entsteht.

? Das Problem besteht darin daß der Parser von w-w-w, also der
Textfilter der abgeschickte Beiträge filtert mehrfach
Leerzeichen rauswirft.

Dass mehrere Leerzeichen zu einem einzigen Leerzeichen zusammengefasst werden, ist nur ein Teil des Problems. Auch wenn die Zeichen nur durch jeweils ein Leerzeichen getrennt werden, können Tabellen und Code nicht vernünftig dargestellt werden. Beispiel:

A B C D E F G
1 2 3 4 5 6 7

Die Zeichen sind in der Eingabe jeweils durch ein Leerzeichen getrennt. Trotzdem steht bei der Anzeige die 7 nicht unter dem G.

Ich denke, die einfachste Begründung für den Einsatz der beiden Tags ist: Wenn du willst, dass der Text bei der Anzeige so aussieht wie bei der Eingabe, dann verwende pre oder prehtml.

Das Beispiel im FAQ:3090 ist etwas unglücklich gewählt bzw. dargestellt. Das kommt meiner Meinung nach daher, dass die Eingabe formatiert dargestellt ist. Ich nehme an, dass bei der tatsächlichen Eingabe vor „Sheets“ ein Tab oder mehrere Leerzeichen stehen. In der Darstellung des FAQs sieht man diese aber gar nicht. das ist für einen Laien ziemlich verwirrend. Besser wäre es, die Eingabe in Festbreitenschrift exakt so, wie sie im Browser-Eingabefenster eingegeben wird darzustellen. In etwa so:

Ohne pre-Tag

Eingabe:

A B C
1 2 3

Anzeige:
A B C
1 2 3

Mit pre-Tag

Eingabe:

A B C
1 2 3

Anzeige:

A B C
1 2 3

Noch ein paar Hinweise, die nicht den FAQ:3090 betreffen:

Im FAQ:3084 funktionieren bei der Erklärung von pre die Links auf den FAQ:3090 nicht.

In dem Hilfetext unter dem Eingabetext ist das Tag aufgeführt. Dieses Tag funktioniert bei mir nicht. In den Faqs habe ich auch keine Beschreibung dieses Tags gefunden.

Gruß
Rainer

8

Guten Tag.

Leider sind Jessica, die FAQ-Betreuerin und ich schon
gewissermaßen zu überqualifiziert um da im Text der FAQ zu
sehen wo es bei ähem Ungeübten hängen könnte beim Verständnis.

Drei bis zwei Tricks, die ich (musste schon so allerlei in der Richtung verfassen) gerne anwende, und die ich als hilfreich erlebt habe:

Die gewohnten Einstellungen am Blechkumpel möglichst heftig verdrehen. Maus von Rechts- auf Linkshandbedienung (oder umgekehrt) und das Anklickverhalten verändern (Reaktions- und Cursorgeschwindigkeit), Tastaturtreiber bspw. auf Französisch setzen, Bildschirmauflösung total verändern bzw. mit [STRG ALT Pfeil] das Bild kippen und dann den Screen wieder aufrichten …

Dann versuchen, an diesem verwurstelten System die eigenen Anweisungen aus der Anleitung zu befolgen. Dadurch, dass man diese Einstellungen nicht auswendig kann, versetzt man sich in die Rolle eines ungeübten Benutzers - und fällt in viele der Fallen, die man im Text versteckt hat.

Die andere Möglichkeit ist das Umschalten in den DOOF-Modus (Übungssache). Also, wortwörtlich die Anweisungen befolgen:

„Tragen Sie in das Feld Benutzer Ihre Benutzerkennung ein. Dann schreiben Sie Ihr Kennwort in das dafür vorgesehene Feld und schicken Ihre Eingabe mit der ENTER-Taste ab“.

Benutzerkennung sei HANSJOCHEN, Kennwort „APRIL09“.

Was man da schon alles falsch machen kann:

  • BenutzerkennungKennwortENTER „Hallo Hotlein, mein Computer geht nicht.“

  • HANSJOCHENAPRIL09{ENTER} „Hallo Hotlein …“

  • HANSJOCHEN{ENTER}[Fehlermeldung]APRIL09{ENTER} „Hallo …“

GEK

9

Hallo Reinhard,

noch ein Punkt, der mir aufgefallen ist:

da die FAQ ja für völlig unbedarfte gedacht ist, solltest du nicht von Quellcode sprechen. Sonst geht der Gedankengang in etwa:

„Ich weiß nicht, was das ist, ich will sowas nicht schreiben, also kann ich diesen Teil überlesen.“

Schreibe einfach nur von Text und Format, das ist wahrscheinlich zielführender.

Gruß

Kubi

10

Sehr gute Anregungen, ich bedanke mich o.w.T.

11

[Team] jau, ich bedanke mich auch
Hallo zusammen,

auch von mir herzlichen Dank für die Tipps. Ich werde die FAQ in dieser Woche noch einmal überarbeiten.

Viele Grüße
Jessica