Eddie: Dokumentstruktur einer SelfHTML-Seite

Beitrag lesen

Hallo Christoph,

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

Achwo. Ich bin die Liebenswürdigkeit in person.

:-) Eigentlich konnte ich mir auch nichts anderes vorstellen. Drum hab ich ja auch "Eindruck" geschrieben. Aber diesen Eindruck gibt's eben manchmal, ist halt bloed im Internet, weil man die Leute dabei nicht zwinkern sieht.

Ein monströses Tutorial

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

Nach Wahrigs Deutschem Wörterbuch (mon'strös, mons'trös <Adj.; -er, am -esten> ungeheuerlich; missgestaltet [<lat. monstrosus „ungeheuerlich; missgestaltet; scheußlich“, urspr. „wunderbar, widernatürlich“]) sollte ich das tatsaechlich. Hast recht.

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.

Trotz allem sagt mir Google, dass es unter de.selfhtml.org über 64.000 Einzelseiten gibt: http://www.google.de/search?hl=de&c2coff=1&q=site%3Ahttp%3A%2F%2Fde.selfhtml.org&meta=.
Wenn das nicht die Bezeichnung "gigantisch" verdient, dann weiss ich auch nicht.

du sagtest, daß du dir ein Hilfesystem aufbauen möchtest. Aber wo soll das laufen?

Im WWW, mittels PHP, um die verschiedenen Funktionen meiner Website http://www.umdiewelt.de/ zu dokumentieren. Die Texte selbst sollen in der DB lagern, einfach weil das bisher auch so ist und sich bewaehrt hat. Jeder Text jeweils in englischer und deutscher Fassung.

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.

Und genau das will ich erreichen. Leicht zu findende und zu verstehende Informationen, ohne das der Anwender erst die Funktionsweise erlernen muss.

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.

Ok, meine Zielgruppe sind Menschen, die zwar eine gewisse Affinitaet zum WWW haben, denen aber meistens der technische Hintergrund fehlt. Denen moechte ich Fragen beantworten koennen, und zwar
a) ohne dass sie mir jedesmal eine Mail schreiben muessen, auf die ich wiederrum ausfuehrlich antworten muss - das ist naemlich ziemlich zeitaufwendig
b) so, dass sie die Information selber finden koennen, und ich ihnen ggf. per Mail einen Link zu dieser Information schicken kann.

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.

Siehst du, und das klingt jetzt schon wieder unleidlich. Wenn du das schon fuerchtest, dann haette ein Link an dieser Stelle nicht geschadet.
Aber ich kann dich beruhigen, zu diesem Thema habe ich erst letztes Jahr ein Referat gehalten. Zugegebenermassen heisst DTD fuer mich aber automatisch XML, und XML wollte ich jetzt eigentlich nicht verwenden, weil ich die entsprechenden PHP-Bibliotheken nicht kenne und - ich geb's zu - gerade auch zu faul bin fuer sowas. Aber vielleicht sollte ich mir das nochmal ueberlegen.

Also worum geht es nun?

Um den Aufbau eines Hilfe-Systems/einer Dokumentation mittels PHP/HTML/MySQL(/XML) und unter Verwendung eingebetteter Bilder inkl. optionaler Bildunterschrift. Jeder Hilfeabschnitt muss ueber eine konkrete URL erreichbar sein, gegebenenfalls mittels Ankern.
Ich muss also in der Lage sein, entsprechende URLS per Mail zu verschicken und an beliebiger Stelle meiner Website diese Links zu setzen.
Die Dokumentation soll bei Klick auf einen Hilfelink in einem separaten Fenster ablaufen, wobei sich das Design am globalen Design von umdiewelt.de orientieren wird, allerdings etwas schlichter, z.B. so: http://www.umdiewelt.de/contact.php?m=w&s=Frage zu www.umdiewelt.de.
Themen werden z.B. die Bedienung der Seite sein (also Technisches), eine Liste häufiger Fragen ("FAQ"), aber auch Philosophischeres, z.B. zu Themen wie "Schreibstil im Internet".
Im oberen Bereich brauche ich eine "Kruemelspur", um eine baumartige Struktur zu simulieren. Anfangs, solange wenige Texte vorhanden sind, ist das aber kaum noetig.

Wenn dir dazu noch was einfaellt - seien es Kritik oder Ideen - wuerde ich mich sehr freuen, wenn du noch was schreibst. Ich hoffe, diesmal war ich etwas konkreter und leichter zu verstehen.

Eddie

--
Old men and far travelers may lie with authority.