Christoph Schnauß: Dokumentstruktur einer SelfHTML-Seite

Beitrag lesen

hallo Eddie,

Kommt naemlich ziemlich haeufig vor, dass du einen ziemlich unleidlichen Eindruck machst.

Achwo. Ich bin die Liebenswürdigkeit in person.

SelfHTML ist ein gigantisches Hilfesystem, oder etwa nicht?

Nein. In Korrelation zu meiner von Stefan unten angesprochenen (Alters-)Brummigkeit bin ich gegenüber Superlativen wie "gigantisch" mehr als skeptisch. SELFHTML ist, nüchtern betrachtet, eine Dokumentation mit beachtlichem Umfang. Wie alle Dokumentationen auch, leistet SELFHTML selbstverständlich einige unschätzbare Hilfen, das steht außer Frage. Ich selber habe nahezu alles, was ich je "im Web" umgesetzt habe, an, mit, gegen, in Dankbarkeit für oder in Opposition zu SELFHTML überhaupt erst gelernt.

Ein monströses Tutorial

Du solltest dein Begriffsverständnis für "Monster" dringend revidieren, finde ich.

du sagtest, daß du dir ein Hilfesystem aufbauen möchtest. Das kannst du gerne tun. Aber wo soll das laufen? Auf deinem eigenen Rechner zuhause? Unter welchem Betriebssystem?
Ja, du hast recht, habe ich nicht geschrieben. Also nimm das Naheliegenste, das macht man in solchen Faellen so. Mal abgesehen davon, dass das Zielsystem bei so einer abstrakten Anforderung herzlich egal ist.

Nö. "Man" schaut nicht zuerst nach einer möglichen Form, sondern "man" überlegt sich zuerst, was man denn wem gerne als Hilfesystem anbieten möchte. Es ist unerläßlich, das grundlegende Thema nicht irgendwie abstrakt, sondern ganz konkret vorzuformulieren. Ich könnte beispielsweise ein Hilfesystem für meine Küche brauchen, im Gegenzug könnte ich mir überlegen, wie ich ein Hilfesystem für künftige Holunderweinhersteller zusammenstellen sollte. Die richtige Motivation dafür kriege ich nur zusammen, wenn mir das "Zielsystem" dafür alles andere als egal ist.

was, ums himmels willen, haben denn Zeilenumbrüche mit einem Hilfesystem zu tun?
Welche Zeilenumbrüche? Herrgott, das ist nur eine Beispielseite fuer ein Hilfekapitel. Wohl zu abstrakt...
Ich dachte, wenn ich schreibe


ich meinte die typischen SelfHTML-Seiten, wie z.B. http://de.selfhtml.org/html/text/zeilenumbruch.htm


wuerden die meisten Leute verstehen, dass das ein Beispiel ist, und ich einen Zusammenhang zu den "typischen SelfHTML-Seiten" herstellen will. Vielleicht ist das Adjektiv "typisch" in diesem Fall verwirrend?

Nö. Ich sollte die "typischen SelfHTML-Seiten" seit ungefähr 1998 ziemlich gut kennen. Sie zeichnen sich im wesentlichen dadurch aus, daß es zwar ein nahezu immer wiederkehrendes Layout gibt, dieses Layout aber gegenüber dem tatsächlich transportierten Inhalt zurücktritt.

Ist uebrigens nicht so, dass ich mir mein Original-Posting nicht nochmal durchgelesen hätte. Und ich räume durchaus ein, dass beim eiligen Überfliegen nicht gleich klar ist, worum es genau geht.

Siehst du, da kommen wir ja langsam an eine Stelle, an der man weiterreden könnte. Ich habe ein kleines bißchen Erfahrung, was das Zusammenstellen von Dokumentationen angeht. Auch online-Hilfen für Teilnehmer meiner Kurse habe ich schon geschrieben, und da ich die Jungs immer auch unmittelbar und direkt vor mir sitzen hatte, weiß ich natürlich, wie meine "Zielgruppen" auf solche Leseangebote reagieren können  -  allerdings nicht müssen. Immerhin kann ich ganz gut abschätzen, was man einer bekannten Zielgruppe an Hilfestellung und/oder Dokumentation anbieten kann.

Aber ich schaetze die Forumsteilnehmer als so intelligent ein, dass sie's trotzdem raffen.

Wenn du das Forum kennst, weißt du, daß es nicht nur eine "Kultur des Antwortens" gibt, sondern auch eine "Kultur der Fragestellung"  -  und die mußt du dir in den nächsten zwei Tagen noch zu eigen machen. Die Forumsteilnehmer sind in der Regel tatsächlich ziemlich intelligente und/oder irgendwie gescheite Leute. Es muß ja auch einen Grund haben, weshalb sowohl Andreas wie auch Jeena auf die Idee gekommen sind, dir mit einem vagen Hinweis auf eine DTD zu kommen  -  ich fürchte allerdings möglicherweise zu recht, daß du damit (noch) nix anfangen kannst.

Also worum geht es nun?
Du willst eine Dokumentation zu irgendeinem Thema verfassen, die du aber "Hilfesystem" nennst. Das kannst du natürlich (ich wiederhole mich) gerne machen. Aber du hast dein Thema, für das diese Hilfestellung gelten soll, (noch) nicht angegeben, es kann dir also keiner bisher ein paar unterstützende Hinweise geben, welche (thematischen) Details ins Konzept aufgenommen werden sollten. Du hast nur eine absolut abstrakte und nicht einmal schöne Struktur benannt, in der man sowohl ein Kochbuch wie auch eine Anleitung zum Aquarienbau unterbringen könnte. Für beide Themen hätte ich durchaus Details parat, die ich dir nennen könnte, gleichzeitig habe ich bei beiden Themen noch allerhand Lernbedarf. Aber was hilfts dir, wenn ich dir erkläre, mit welchen Chemikalien Silikonkleber für Aquarien hergestellt werden sollten, wenn du doch eine Dokumentation über Klavierbau zusammenstellen möchtest?

Fazit: deine Fragestellung war schlicht und einfach viel zu ungenau. Präzisiere sie. Erkläre, was du nun wirklich vor hast. Nimm dir nicht zuviel auf einmal vor. Es ist besser, mit kleinen Schritten anzufangen und sich die Option zur Erweiterung offenzuhalten, als mit einem "gigantischen" Anspruch loszumarschieren und nach wenigen Tagen schemrzhaft auf der Nase zu landen.

Grüße aus Berlin

Christoph S.