Anwender Handbuch?

TiCar · 16. Feb 2006, 12:01

Hi,

hab neulich mal die Suche durchwühlt und so direkt leider nichts gefunden. Natürlich kenne ich das PDF welches zum Download gibt und diverse Wikipedia einträge.

Da ich aber meinen 'Kunden' ein sogenanntes Anwenderhandbuch mit auf den Weg geben möchte, da viele Endkunden doch gar keine bis wenig HTML und noch weniger PHP Kenntnisse haben, möchte ich sie damit auch nicht belasten. D.h. das Anwenderhandbuch soll ausschließlich auf verwendung von Modulen, Benutzer anlegen, Medien uploaden, Gästebuch-, Glossar-, Referenzlisten-, ... Verwaltung eingehen.

Nun die Frage gibt es sowas schon, oder Ansätze dazu? Wenn nicht werde ich mich bei zeiten hinsetzen und sowas mal in Word verfassen, mit Index, Verzeichnis etc. pp.
Oder welches System wäre den Entwicklern recht, damit man es universell einbinden kann (Homepage).

Wie gesagt soll später als PDF dem Kunden mitgeliefert werden, da ich inzwischen ein, mehr oder weniger, komplettes Paket mit SQL Skripten geschnürt habe, welches natürlich immer wieder erweitert und verbesser wird und schon diverse Basisdinge integriert hat. Aufbauend auf dem CVS sind darun enthalten, CSS Editor, Glossar, Referenzliste, Gästebuch, Counter, SimpleShop, HassoGallery, diverse vorinstallierte Module, ...

D.h. müßte diverse Anpassungen machen, bzw. einige Bereiche in der Doku weglassen bei einer Demo oder Standardinstallation (Module aus der Demo, ohne Struktur und Files bis auf das CSS).

16. Feb 2006, 12:43

Hej,

mir ist soetwas nicht bekannt. Ist auch von Kunde zu Kunde sehr spezifisch. Welche Kunde hat die gleichen Addons/Module wie ein anderer Kunde.

Das ganze müste aus der Taufe gehoben werden. Und zwar so das man sich das Handbuch selbst zusammenstellen kann.

Ein Formular mit checkboxen für jedes Addon/Modul/Medienpool usw. usf. Da könnte man dann auswählen, welche Inhalte im Handbuch erscheinen werden. Das ganze passiert dann dynamisch, wegen dem Inhaltsverzeichnis.

Unter Settings kann man seinen eigenen Briefbogen hinterlegen, der dann mit im PDF erscheint.

So ein Gedanke von mir.

vg Thomas

PS: Word würde ich auf keinen Fall verwenden. Das hat nicht jeder.

TiCar · 16. Feb 2006, 19:17

Hi Thomas,

welches System würdest du denn vorschlagen. XML Daten, OpenOffice, oder einfach zu jedem Modul oder AddOn ein eingenständiges PDF. Dann kann man sich die einzelnen PDFs entsprechend selber zusammenstellen, nur mit dem übergreifenden Index und Inhaltsverzeichnis wirds dann problematisch. Mit strukturierten Worddokumentationen kenne ich mich halt am besten aus. Am Ende kommt ja dann eh eine PDF raus, die dann jeder ansehen und ausdrucken kann. Ok, Problematisch ist dann wie du sagst die einbindung oder weglassen der Module *grübel*

hab leider noch nie eine druckbare PDF Page gemacht, geschweige darin ein Inhaltsverzeichnis mit Index erstellt, wenn sowas überhaupt geht per HTML/XML. Hoffe es kommen noch paar Vorschläge da ich ungern die arbeit doppelt mache und die Allgemeinheit ha auch was davon haben soll

16. Feb 2006, 19:26

Hi Ihr 2,

ich würd das ganze mit HTML Seiten machen.

Dann kannst du am einfachsten Indizes/Inhaltsverzeichnisse etc anlegen.

Vielleicht sogar so, das man aus REDAXO heraus an verschiedenen stellen direkt in best. Artikel des "Manuals" springen kann.

Gruß,
Markus

16. Feb 2006, 19:40

Hej,

kills hat geschrieben:Vielleicht sogar so, das man aus REDAXO heraus an verschiedenen stellen direkt in best. Artikel des "Manuals" springen kann.

genauso würde ich das auch machen. Und zwar das ganze als Addon vielleicht. So kann der Webmaster auch noch eigene Hilfedaten shreiben die dann beim benutzen des Moduls via extension point im modul mit angezeigt werden oder auch am artikel direkt.

also ich würde da als addon aufziehen

vg thomas

16. Feb 2006, 19:54

Hi,

tbaddade hat geschrieben:also ich würde da als addon aufziehen

Jepp, meine Meinung..

Gruß,
Markus

TiCar · 16. Feb 2006, 21:37

Hi,
finde ich eine super Idee. Dann werd ich mal schauen ob ich das hinbekomme und euch mit Fragen nerven, wenn ich was nicht weiß

Die erste kommt direkt:

Wie sieht es denn mit der PHP fähigkeit solcher HTML Dokus aus? Wie erstellt man da ein automatischen Index und Inhaltsverzeichnis? Könnt ihr mir da etwas auf die Sprünge helfen, um grundsätzliche Fehler von Haus aus zu vermeiden? Gibts es dazu irgendwelche Pages wo ich mich mal einlesen kann?

Ich kenne aus dem Geschäft bisher nur sowas wie CHM (nennen sich glaub auch HTML Hilfen) Dateien welches aber mit Word geschrieben wird und wohl absolut nicht geeignet sind denke ich. Hab ja bisher noch kein AddOn gebaut, aber wollte ich eh so langsam ran gehen, weil mir die Sicherung und Export/Importfunktion nicht so gefällt. Module muss ich z.b. bisher immer manuell ex- & importieren.

16. Feb 2006, 23:16

Hi Lars,

das mit dem Index würde ich mit einem Extension Point machen.

Einfach im Inhaltsverzeichnis einen EP definieren und jedes Modul das sich eihängen will, kann via rex_register_extension einen Eintrag in den Index einfügen...

Die einzelnen Seiten der Module einfach als reine HTML Seite in ein TEXT Feld der DB gehauen. Formatierungen würd ich dann mit Textile machen. (Evtl würd ich sogar dafür ganz normale Artikels aus der Struktur nehmen, da du dann dort Modul etc verwenden kannst.

Wie baue ich ein Addon...?
Am besten mal mit dem simpelsten Addon anfangen (opf_lang). Das ist ganz easy aufgebaut. Einfach mal einlesen.

Gruß,
Markus

TiCar · 20. Feb 2006, 17:08

kills hat geschrieben:Hi Lars,

das mit dem Index würde ich mit einem Extension Point machen.

Einfach im Inhaltsverzeichnis einen EP definieren und jedes Modul das sich eihängen will, kann via rex_register_extension einen Eintrag in den Index einfügen...

Die einzelnen Seiten der Module einfach als reine HTML Seite in ein TEXT Feld der DB gehauen. Formatierungen würd ich dann mit Textile machen. (Evtl würd ich sogar dafür ganz normale Artikels aus der Struktur nehmen, da du dann dort Modul etc verwenden kannst.

Wie baue ich ein Addon...?
Am besten mal mit dem simpelsten Addon anfangen (opf_lang). Das ist ganz easy aufgebaut. Einfach mal einlesen.

Gruß,
Markus

Hi,
danke für den Tipp. hab mal mit dem AddOn (opf_lang) angefangen, aber das bedarf glaub noch etwas längere Einarbeitungszeit bis ich soweit bin *urgs*

Folgendes ist bisher geplant

Bei der Eingabe eines Hilfetextes wird zur Auswahl eine Liste der Module, Templates und AddOns zur Verfügung gestelt zu der man dann den Hilfetext eingeben möchte (vorerst in einem normalen Textfeld - später kann man dann versuchen dieses über Slices zu steuern unter der Verwendung der vorhandenen Module, wie du es vorschlägst)

Dabei wird der ID und der Name der Tabelle, bzw. Typ gespeichert mit dem entsprechenden Text. D.h. in Verbindung von $id und $table erhalte ich einen eindeutigen Key zu welchem Modul/Template dieser Hilfetext gehört. Bis hierher denke ich es gebacken zu bekommen. Schön wäre es, wenn im ModulMenü eine weitere Spalte (z.b. ein Fragezeichen) zur Auswahl der Hilfe erscheint, welche man anklicken kann. Hab ich kein Plan wie ich sowas umsetzen kann. Sind damit die Extentions Points gemeint?

Probleme sehe ich mit dieser Lösung ebenfalls diese für AddOns oder andere Dinge wie Benutzer, Medialist, ... in den Griff bekomme. Hier fehlt mir eine entsprechende Idee, bzw. von der Umsetzung ganz zu schweigen.

Bräuchte da auf jeden Fall etwas Schützenhilfe von erfahrenen Redaxianern

vll. kommts ja noch wenn ich weiter in den opf_lang einarbeite