?Anleitung?

Begonnen von dg3nec, 22 August 2002, 12:51:59

⏪ vorheriges - nächstes ⏩

0 Mitglieder und 2 Gäste betrachten dieses Thema.

dg3nec

Ich habe das VPK maxi jetzt bei mir in betrieb genommen. Mit den üblichen Geburtswehen *grins*. Es ist mein erster Kontakt mit einem Nuke-System. Wenn ich richtig verstanden habe, soll das VPK ja sozusagen ein "Komplett-Paket" darstellen. Deshalb habe ich es ja auch genommen. Ich will ja etwas betreiben und nicht jeden Tag daran rum progammieren. Sozusagen rundum sorglos. Was meine bisherigen Eindrücke auch bestätigen. Sehr großese Lob an eure Arbeit!!

Doch eines fehlt mir als "Neuling" absolut. Gibt es denn zum VPK keine komplette Anleitung? Man ist immer am suchen und wühlen nach Informationen. Doppelt posten will man ja auch nicht. Ewig suchen aber auch nicht! Und dann bevor man postet stellt man sich die Frage ob man sich mit dieser Frage nicht als "Blindflansch" outet.

Die Installationanleitung ist schon knapp gehalten. Naja, man könnte jetzt fragen gibt es mehr dazu zu sagen? Eventuell ein wenig Hintergründe zur Installation wären nicht schlecht.

Was ich bisher nicht gefunden habe ist eine Bedienungsanleitung zum VPK. Man ist als Neuling am Probieren und findet immer wieder Neues. Teilweise plagt man sich arg mit den Modulen und deren administration. Meist klärt sich dies dann wenn man dann nach der Methode "Try and Error" mal ausprobiert. Vor allem das Anpassen an die eigen Ansprüche fällt schwer.

Was ich also suche, oder gerne hätte, ist eine komplette Anleitung um das VPK  einzurichten, zu betreiben und zu pflegen. Kann auch nach Themen/Kapiteln gesplittet sein als einzelne Files zum Downloaden. Hätte den Vorteil das man sich das dann Ausdrucken kann, und im Falle eines Updates nur einige Seiten austauscht.

Ich weiss das Programmierer lieber Coden als Anleitung schreiben, das ist schon seit jeher so. Kostet auch jede Menge Zeit, ich weiss. Trotzdem würde es den VPK-Paketen gut zu Gesicht stehen auch in dieser Richtung etwas zu bieten. Es ist letztlich dann auch ein Anreiz, sich für Euer Projekt zu entscheiden. Vorschlagen würde ich für jedes Modul ein eigenes Kapitel zu erzeugen. Enthalten sollte es: Inbetriebnahme(Installation), Bedienung, Administration, Tips&Tricks, häufige Fehler/Probleme und deren Lösung.

Wenn es sowas bereits schon gibt, sorry das ich so blind bin und sagt mir bitte wo ich es finde. Ansonsten nehmt es mal als Anregung mit auf Eurem Weg, auf dem ich Euch alles gute Wünsche. Vieleicht gibt es ja Freiwillige die euch dabei unterstützen würden. Man muss ja nicht alles alleine machen.

jogi24

hi
@dg3nec

deine anregung ist gut, aber wenn wir solch eine anleitung schreiben würden,
wass uns sehr viel zeit kosten würde, währe dieses forum nicht mehr nötig.

darum stelle doch alle deine fragen hier im forum, du bekommst sicher eine erklährung für
deine probs.

 :quest  :thumbup:  :quest

dg3nec

OK, werde ich tun.
Allerdings bin ich nicht der Meinung das ein Forum eine Strukturierte Anleitung ersetzen kann. THX

jogi24

hi
@dg3nec
anderer vorschlag:

fang doch einfach mal an eine anleitung zu schreiben,
alle deine wege der installation usw. zu papier bringen,
und hier posten.
wenn sich alle user daran beteiligen, kann doch doch ein manual werden, oder.

 :quest  :thumbup:  :quest

Micro

Im Grunde muss ich Dir Recht geben.
Eine Bedienungsanleitung wäre sicher mal etwas, das man gerade für Neulinge mit veröffentlichen könnte.
Problematisch ist hier tatsächlich die Zeit. Wobei das sicher die Ausrede eines jeden Programmieres ist *smile* Denn "Hauptsache es läuft" ... ;o)

Ich kann Dir das hier mal empfehlen zu lesen.
Dort wirst Du auch etwas fündig, was die Grundstruktur zum PHPNuke erklärt. Denn der Grundumfang ist in großen Teilen noch der selbe. (PHPNuke 5.1)
http://www.netz-id.de/article.php?sid=44

Mirko

dg3nec

Das ist doch ein Wort !!

Vorschlag ist also eine Anleitung die von den Usern selbst kommt und geschrieben wird. Mal sehen ob sich welche finden die da mitmachen. Wer ein paar Zeilen beitragen will, könnte ja mal gleich hier Antworten.

Und welches Format soll es denn sein?  Das ist ja die Vorraussetzung um was auf die Beine zu stellen. Ein sauberer Ausdruck sollte möglich sein. Schlagt vor was euch am liebsten wäre. Ich stimme einfach mal für Word. Und dann das ganze verteilt auf mehrer Dokumente, so das man je nach VPK das kriegt was im Paket drin ist.


Micro

Im Grunde würde dafür ein reinses Text Dokument ausreichend sein.

Das kann man dann so umsetzen, übersetzen wie man es möchte. HTML, PHP oder anderes Format.
Aber goil ;o) Schön das sich jemamd an diese Sache setzen will ;o))

dg3nec

Textformat, OK.

Werde es mal versuchen. Mal sehen sehen was zusammen kommt. Ich schreibe einfach mal mit. Der Rest ergibt sich. Wenns schief geht, tja war ein Versuch. cul

DarkBoy

HI
 iich werde Euch  hier ein Modul zur Verfügung stellen, dann könnt ihr das  direkt in die DB schreiben ,   so quasi  USER bauen eine FAQ auf :)

Setze mich da mal ran gleich   ansonsten  kleine Codesnips  können schon eingestellt werden.

jogi24

Hi
@dg3nec

schön das den mut gefunden hast dieses werk in angriff zu nehmen.

die unterstützung des gesamten admin-theams ist dir gewiss.

viel spass und erfolg .

 :quest  :thumbup:  :quest

EdeWuff

Hi all,

ist das Werk schon begonnen / fortgeschritten ?
Ich möchte mich gerne beteiligen. Ich habe festgestellt, dass ich wohl mit den meisten strukturellen Problemen fertig werde. Allerdings haben die BesucherInnen meines neuen Sportportals die gleichen Schwierigkeiten wie ich, wenn es darum geht zu kapieren, was sich hinter den vielen Begriffen wie eBoard, SubmitNews ... verbirgt. Meine Zielgruppe sind aber Läuferinnen und Läufer und keine WEBMaster - es fehlt also die Erfahrung. Da wäre ein Handbuch / Anleitung / FAQ "wie bediene ich das VKP und wo finde ich was" echt angebracht.
Jetzt habe ich ein paar Tage Urlabub - danach steige ich dann voll ein - wenn dann also das Modul (Admin DarkBoy) zur Verfügung stünde ...

ICH BIN DABEI :)

Micro

Oh Hülfe ;o)

Also gut. Ich hab die neue Doku Version soweit fertig programmiert. Das einzige was nun nur noch fehlt, ist die Doku für die Doku selbst. Also wie sollte man was in welcher Reihenfolge schreiben.

Im Grunde reichen erst einmal simple HTML-formatierte Textzeilen, der eine Überschrift "um was es sich dabei handelt", zu.

Wer die eBoard Doku kennt, hier ist genau die selbe Doku, nur eben schon "im" neuen Format untergebracht mit den alten HTML Files. (Deshalb funktionieren einige Links innerhalb der einzelnen Seiten auch nicht, weil diese auf der "alten" Struktur basieren!!)

http://docs.pragmamx.org/mxBoard//

Zum Vergleich die vom ModService, die komplett neu entstanden ist:

http://docs.pragmamx.org/modservice/

So sollen und werden in Zukunft die Dokus aussehen, die wir mitliefern wollen und die ebenfalls für das "Modul-Zertifikat" benötigt werden.

Ich werd dann wohl oder übel  :) in den kommenden Tagen mal den Rest der einzelnen Formatierungen (CSS Angaben) in eben dieser Form hier veröffentlichen.
Ich denk zusammen finden wir eine "Sprache" die dann auch wirklich alle verstehen.

Mirko

[Editiert am 12/9/2002 von SiteAdmin Micro]

DarkBoy

Hi
so  mal ein kleines Post zum FAQ Project. Sollte noch Interessierte vorhanden sein, starte ich neben der von Micro betreuten   hauseigenen DOKU  ein FAQ Project.

Wer nun Lust hat da aktiv ( produktiv und auch mit Hilfe) einsteigen möchte, eine  Allround FAQ Datenbank aufzubauen, möge sich per mail oder PM bitte an mich wenden.(oder halt hier)

Dieses Project wird unabhängig von Nuke und dem VKP Mxxx laufen. Es wird Tuts und FAQ zu allem rund um Apache, MySQl, PHP, usw oder zu Wünschen-sprich Interessengebieten von Euch beinhalten und kann von jedem User gefüttert werden.  Die leute die Interesse haben übernehmen ADMINfunktionen zur Verwaltung und zum Ausbau.

Sicher wird auch eine Nuke Allgemeininfo vorhanden sein und mehr. So long, verbleibe ich und  warte auf Unterstüzung und Hilfe, da zur guten Pflege und Aufbau mir alleine die Zeit auf Grund eigener Projecte(Pragma,Shop,Hosting) fehlt. Es ist ein Project zum Wohle und zum helfen für alle.

DarkBoy

Noch was vergessen. Wer schon Tuts oder FAQ hat und die zur Verfügung stellen möchte, kann dieses natürlich auch gerne tun.

So warten wir mal ob  ein paar Leute lust haben zu helfen.

DarkBoy

Hallo,
so wie es aussieht hat keiner Interesse hierbei mitzuhelfen. Alleine  aus Zeitgründen schaffe ich dieses nicht alleine und werde es somit  nicht starten. Schade eigentlich aber  es geht sonst leider nicht.

EdeWuff

Hi Leute,

ich bin nun aus dem Urlaub zurück und würde gerne an der DOKU mitarbeiten.

Also los ... ;-)

Gruß, Peter

Micro

Also dann, wie soll die Doku aussehen?

1. die Struktur:

Welche Reihenfolge haltet ihr für notewendig?

Ich mach hier mal ein paar Beispiele oder Vorlagen:

User Doku Your Account
- Ihre Benutzerdaten
- Ihre Einstellungen
- Abmelden

User Doku allg.
- News lesen
- neue News schreiben
- News kommentieren
- Downloads
- Download hinzufügen
- Download Kategorien – Erklärung Neu / Beliebt / Topbewertet
- Weblinks
- Weblink hinzufügen
- Weblink Kategorien - Erklärung Neu / Beliebt / Topbewertet / Zufall

etc.
--------------------------

Admin Doku
- Administration
- Artikel
- Benutzer
- Benutzer Config

etc.

Also alles durch was in der Administration im "normalen" Paket enthalten ist, das zur Administration des Portals benötigt wird.

Wie muss die Doku dazu aussehen?

Ich brauche dazu jeweils eine Datei die NUR in Form von HTML vorliegt und folgenden Inhalt haben sollte in dieser Reihenfolge:


<!--
Kategorie: Admin Doku oder User Doku allg. oder User Doku Your Account
Überschrift: Weblinks hinzufügen
Kurzbeschreibung: wenn notwendig (z.B. was muss man beachten beim hinzufügen von Weblinks)
-->

Der Text im HTML Format

Text mit Screenshots und der Einheitlichkeit halber bitte mit dem Thema vkp_modules_1

Die Formatierung wird in CSS gehalten. Eine Vorab Dokumentation gibt es hier zu sehen.
http://docs.pragmamx.org/ModDoku/

Ist aber noch nicht ganz fertig, da noch einige kleinigkeiten fehlen.
Sollte aber erst mal nicht abschrecken ;o)

Keine Zusätzlichen Spielereien in den Formatierungen, es wird NUR das verwendet was schon vorhanden ist. Es sei denn man überzeugt mich von der ein oder anderen Notwendigkeit. ;o)


-------------------------

Die Screenshoots die hinzugefügt werden sollen, müssen eine einheitliche Breite von 400px besitzen. Es muss in vielen Fällen keine Original Größe sein, da eine Übersicht in vielen Fällen ausreicht.

Die Bilder werden zur Datei im eigenen Unterordner /images/[Dateiname] gespeichert, also bitte schon so mit hinzufügen.

Nur *.gif (kein AOL gif) oder *.jpg

Grafiken sollten die Größe von 30kb pro Bild nicht überschreiten.


Noch Fragen?


Vergleichs Dokumentationen:
http://docs.pragmamx.org/modservice/
http://docs.pragmamx.org/SP1/

Ach ja, noch etwas.
Ich möchte von jedem(!) der an der Doku mitschreibt und eine Seite dazu beiträgt, den Namen und Link oder Mailadresse ganz unten rechts dazufügen. Wenn es mehrere sind, dann werden es eben mehr ,o)

[Editiert am 7/10/2002 von SiteAdmin Micro]

Ria

Hallo,
wer vermutet dieses in der Mecker-Ecke, bin jetzt zufällig drauf gestossen.

Aber die Anleitung ist mir schon zu kompliziert. Ich habe bestimmt schon 30 DIN A4 Seiten begleitend zu meiner Webseiten-Erstellung als Anfänger nur für mich geschrieben.

Ich werde mir die Sache noch mal hier in Ruhe durchlesen.

Aber geht das nicht auch noch einfacher, eine spezielle Formularseite die man einfach downloadet und da was reinschreibt und zurückschickt?

Vielleicht kapiere ich Euer Modell auf die schnelle nicht aber da werden schon einige im Vorfeld kapitulieren.

Das müßte so funktionieren, im Sinne eines cms, wie für einen Redakteur, der sonst von nichts ne Ahnung hat.
Ich meine damit keine Einarbeitung in dieses FAQ Modell.

Na ja, ich sehe es mir mal was genauer an.

Gruss Ria

PS. warum nicht einfach ein Reviews Modul und anstatt Kommentare Ergänzungen?

Dann braucht man sich nicht umstellen jeder kann mitmachen und sortieren kann man das dann 1x monatlich...?

[Editiert am 1/11/2003 von Ria]

Future

 
ZitatPS. warum nicht einfach ein Reviews Modul und anstatt Kommentare Ergänzungen?

Dann braucht man sich nicht umstellen jeder kann mitmachen und sortieren kann man das dann 1x monatlich...?

 

Das FAQ Modul würde sich besser machen da man dort sehr gut sortieren kann wie ich finde. und es kan auch jeder seine fragen stellen .

Also so ne FAQ datenbank wäre scon was schönes ... mal mit den anderen rüber sprechen ;)

Ria

Hallo Kai,

in Reviews kann man aber, glaube ich, einfacher einen screenshot reinsetzen oder?

Ansonsten wäre es mir bestimmt egal. Die Hauptsache man kann was schreiben, in die Zwischenablage, reinsetzen und fertig.

( schließlich sind wir doch in einem cms ;) )

Gruss Ria

Future

hmm ich weiss jetzt gar nicht ob das mit den Screenshots auch im FAQ geht .... naja werds mal mit den anderen absprechen und mir mal was überlegen ... vl klappt das Projekt was Darkboy mal vorhatte ja doch noch :)

Ria

Hallo,
das klappt nur, wenn es so einfach ist, wie ein cms sein sollte! :)

Gruss Ria