CMS - Der Dirigent -> Team zur Handbuchentwicklung

CMS - Der Dirigent » Community » DeDi-Talk » Handbuch

Seiten: (4) [1] 2 3 ... Letzte » ( Zum ersten neuen Beitrag )

Team zur Handbuchentwicklung

« Älteres Thema | Neueres Thema » Thema abonnieren | Thema versenden | Thema drucken

Eppi	Geschrieben am: 03. Sep 2005 - 01:05
.....................noname Gruppe: Admin Beiträge: 8077 Mitgliedsnummer: 1 Mitglied seit: 23. Mar 2003	hallo, da ich nicht schlafen kann bin ich ein wenig am rumstöbern durch unser wiki. dabei fällt mir auf, das wir trotz unserer versuche dies in geordnete bahnen zu bringen (dank mika) dennoch ein heilloses chaos haben. viele informatioenn sind doppelt, hier und da verstreut. es macht viel spaß zu stöbern, keine frage - da man doch hin und wieder mal was ganz neues an informationen entdeckt. die entwicklung neuer module und plugins haben wir über unseren downloadbereich im forum und deren verknüfpung im wiki und auf der hoemapge meiner meinung nach schon recht gut gelöst. vielen dank hier auch an mike der wirklich alle paar tage abcheckt ob es was neues gibt und dies gleich korrigiert. da im forum nun viele leute vertreten sind, die gerne helfen wollen - jedoch nicht programmieren können möchte ich euch die zentrale frage stellen. schaffen wir es zusammen ein ordentliches handbuch zu entwickeln? wenn uns dies gelingen sollte, können wir viele schnippsel, die momentan irgendwo verstreut sind, entfernen und uns noch kompakter präsentieren. wenn ihr wirklich interesse habt zu helfen ist dies eure gelegenheit! wir sollten dann gemeinsam hier im forum diskutieren, wie wir die bereiche gliedern. welches ziel wir mit der demoseite haben und wie wir diese und die homepage in das gesamtkonzept integrieren. die einzelnen bereiche können dann vielleicht immer gruppen von 2-3 oder auch mehr dedi-fans gemeinsam und in eigenständiger arbeit erstellt werden. bereiche, die sich mit der nächsten version noch stark ändern werden lassen wir aussen vor. da ich morgen und sonntag unterwegs bin, können sich ja vielleicht erstmal diejenigen melden, die helfen wollen und die vor allem zeit haben! ihr könnt auch gleich ideen usw. loswerden. dann übernimmt halt einer so ein bissl die koordination. muß ja nicht immer alles von mir gemacht werden - zumindest nicht in dem bereich. ich könnte mir für die zukunft auch noch andere möglichkeiten der präsentation vorstellen wie z.b. das schon öffters angesprochene und von mehreren leuten angefangene, aber nie zu ende gebrachte flash-format als demonstration der möglichkeiten. dies könnte automatisch über xml generiert werden um die erstellung neuer tutorials zu vereinfachen. oder erstmal ein ganz simples handbuch, welches komplett gelöst auch als print-version vorhanden sein könnte und alles in einem abdeckt. die demoseite sehe ich mittlerweile weniger als leere spielwiese, sondern als eine plattform zur demonstration aller verfügbaren stabilen module und plugins. für die einzelnen sprachen scheinen wir genügend übersetzer zu haben. das wichtigste sind jedoch erstmal die deutschen texte. auch hier sollten wir uns nochmal gedanken machen wie wir es präsentieren. hier wäre z.b. eine kurzbeschreibung zum jeweiligen modul und einen link in's wiki zu der moduldokumentation ideal. diese links zu den dokumentationen der einzelnen module sind auf der homepage ja schon vorhanden. hier könnten sich z.b. eine gruppe von 4-5 leuten zusammentun, gemeinsam bereden wie der aufbau der dokumentation gegliedert sein soll und die module auf die einzelnen leute aufteilen. so könnte innerhalb kürzester zeit dieser große leere bereich endlich geschlossen werden. auch hier könnte wieder eine standardmaske zum einsatz kommen. im downloadbereich des forums hat sich dies ja schon recht gut bewährt - wir müssen nur hartnäckig sein und "an das glauben, was wir wollen". gg so, nun hoffe ich, das wir wieder ein stück vorwärts kommen! zum abschluss schreib ich euch noch die letzten punkte, die auf meiner liste stehen, bis dann endlich "DeDi v1.1" veröffentlicht werden kann. damit seid ihr dann auch wieder etwas informationsbeladener, enthusiastischer und hoffentlich so aufgegeilt, das am montag wenn ich wiederkomme ein komplettes handbuch zum download bereitsteht. gruß der paule, jetzt kann ich hoffentlich auch schlafen ToDo (bitte nicht falsch verstehen gg) - Rechteproblem Seite verschieben - Dateien schützen - SafeMode=On - Setup - Defaultsprache (wenn noch nicht online, Seite aus anderer Sprache nehmen) - DeDi-Editor - mod_rewrite URL-konfigurieren - Interne Weiterleitung konfigurieren - htaccess autoamtisch erstellen - Startsprache in DB - alle Module updaten - absolute Pfade fertigstellen - Backendmenu ein/ausblenden - Bildberechnungen im Dateimanager verstecken -------------------- "Heute ist nicht aller Tage... ich komm wieder, keine Frage!"

Manuel	Geschrieben am: 03. Sep 2005 - 09:59
Unregistered	Grundsätzlich finde ich die Idee eines Handbuchs nicht schlecht und es wurde ja auch schon öfter darüber diskutiert - das Ergebnis war AFAIR das Wiki. Meinereiner war ja schon immer dafür ein richtiges Online-Manual zu verfassen, daß sich einfach an den Menupunkten im Backend orientiert. Ich bin also mal ganz innovativ und unterbreite einen Vorschlag zu Layout und Struktur. Der aufmerksame Beobachter wird dabei feststellen, daß er das irgendwoher kennt Ich denke mal, daß diese Struktur selbsterklärend ist. Damit ein Neueinsteiger es möglichst leicht hat braucht er im Handbuch dann nur dort zu klicken, wo er in seinem realen Backend ein Problem hat. Für die, die ganz auf der Leitung stehen gibt es die Suche. Und unter der DeDi-Tour verstehe ich folgendes: Die Tour startet beim Kapitel 'Layout' und springt dann bei Klick auf den 'weiter'-Pfeil zur nächsten sinnvollen Seite; in dem Fall also vielleicht 'Stylesheet'. Dann kommt 'Template' usw. - beim 'zurück'-Pfeil natürlich umgekehrt. Das sollte sich mit dem Linkmodul eigentlich einfach umsetzen lassen. Auf diese Weise kann ein Neueinsteiger sich einfach 'berieseln' lassen und evtl. in seinem eigenen DeDi die Schritte nachvollziehen. Manuel

Cimme	Geschrieben am: 03. Sep 2005 - 19:17
Unregistered	da ich mich persönlich im Wiki nur noch ein paar Minuten zu meinem gewünschten Thema durchgefochten habe, möcht ich gern zum Handbuch Beitragen. Eine Idee meinerseits wäre, wenn wir das Handbuch so aufbauen wie auf php.net, d.h. mit Kommentarfunktion. (denn auch eine Doku kann nicht alles beinhalten) die Einzelheiten lassen sich sicher noch besprechen! Mir persönlich ist es wichtig, dass eine 'Art' Transparenz für den User vorhanden ist. Ergo Übersichtlichkeit! Meine Meinung: Touren und How2s für Anfänger und für die Fortgeschrittenen DeDianer einfach ne Referenz nach Alphabet oder Struktur geordnet. Als how2 wäre es eventl. auch nicht schlecht, wenn an einem Projekt die einzelnen Schritte gezeigt werden. Vom CMS Typo3 weiß ich, wie hilfreich eine schlechte Doku ist, DAS möchte ich dem Dirigenten nicht antun! Grüße

Olaf	Geschrieben am: 03. Sep 2005 - 23:18
offline Gruppe: Members Beiträge: 3689 Mitgliedsnummer: 120 Mitglied seit: 01. May 2003	Ich find die Idee von Manuel genial. Also eine HP die genau so wie das Backend aufgebaut ist. Man könnte sogar soweit gehen, dass man jede Seite des Backends nachbildet und die darauf erscheinenden Symbole/Elemente/Texte mit Links zu Seiten versieht die in gleicher Ansicht die entsprechend Hilfseite einblendet. Fakt ist eins, so super das wäre, es ist eine Heidenarbeit. Und wenn die nächste Version doch noch mal erscheinen sollte geht das ganz Spiel von vorne los. @cimme Ich bin mir nicht sicher aber ich glaub hier geht es um ein statisches Handbuch welches dann zwar auch vom Web aus ereichbar sein würde, aber auch dem Download beiliegen sollte. -------------------- Gruß, Olaf

Cimme	Geschrieben am: 04. Sep 2005 - 00:02
Unregistered	klar, aber sobald man das 'Ausgangsmaterial' hat, lassen sich diese ja relativ zügig in interaktive einarbeiten.

mika	Geschrieben am: 04. Sep 2005 - 00:24
Wurschtler Gruppe: Tester Beiträge: 659 Mitgliedsnummer: 333 Mitglied seit: 09. Oct 2003	ich find manuels vorschlag ebenfalls super. vor allem in kombination mit einer kommentarfunktion wäre das - z. b. mit dem wikimarkup gekoppelt - eine variante, die es ermöglichen würde, die wikiinhalte 1:1 mit einzubauen - falls sinnvoll. dann wären die artikel im wiki auch nicht sinnlos. das hauptproblem seh ich - wie olaf - in den neuentwicklungen von dedi. wie wollen wir ein handbuch aufbauen, dass es für änderungen offen bleiben kann, ohne die gesamtstruktur und aussehen ändern zu müssen. abgesehen davon - ich würd meinen teil mit beisteuern. michel ps. aber jetzt lass ich mich erst mal weiter aufgeilen ))

Eppi	Geschrieben am: 04. Sep 2005 - 08:15
.....................noname Gruppe: Admin Beiträge: 8077 Mitgliedsnummer: 1 Mitglied seit: 23. Mar 2003	so bin 7 stunden fahrt wieder da also das bild führt mich zu einer noch wesentlich geileren idee meiner meinung nach wir bauen den unteren bereich wie man es sieht als webseite wo man sich durchklicken kann. dies ganze allerdings wird zusätzlich in ein plugin gepackt, welches bei einer neuinstallation mit dabei ist. sobald der user jetzt so weit ist das er die hilfe nicht mehr benötigt kann er sie einfach deinstallieren. zum problem neuentwicklungen. ich finde es schade, wenn man dies gleich als ersten punkt aufzählt. es gibt genügen sachen die mit sicherheit gleich bleiben. z.b. wie eine seite angelegt wird, gelöscht wird usw. der dedi-editor trägt doch nur dazu bei sachen zu vereinfachen - aber vom kern her bleibt der aufbau doch gleich. um die doku trotzdem aktuell zu halten wäre es denkbar das plugin als onlineplugin zu entwickeln. das heißt bei der installation des plugins werden im gesamten dedi links zur pluginansicht eingefügt. wenn man darauf klickt kommt man zum entsprechendem thema. die seite selber ist aber im iframe frisch aus dem netz geladen. was haltet ihr von dieser idee? @olaf: keine sorge, es kommt mit sicherheit eine neue version und es wird mit sicherheit auch nciht die letzte sein. gruß, paul -------------------- "Heute ist nicht aller Tage... ich komm wieder, keine Frage!"

mika	Geschrieben am: 04. Sep 2005 - 12:22
Wurschtler Gruppe: Tester Beiträge: 659 Mitgliedsnummer: 333 Mitglied seit: 09. Oct 2003	ich dachte bezüglich neuentwicklung vor z. b. an die screenshots. die müßte man dann halt immer neu machen, falls sich optisch was an den dialogen ändern sollte. z. b. bei einer doku eines moduls - nehmen wir mal dediflex. man möchte z. b. das modul in dem moment abbilden, wenn das popup aufgeht ... usw. falls sich da dann was grundsätzlich ändert muss das bild und der jeweilige beschreibende eintrag ausgetauscht werden. ich seh das jetzt auch nicht als problem an. so ein handbuch wird bei einer software, die sich verändert, nicht statisch bleiben können. aber wichtig ist m. A. n. schon, dass man sich vorher gut überlegt, wie man so ein handbuch gliedert/rastert, damit mans mit neuentwicklungen/änderungen einfacher hat. michel ps: äh manuel - ich war schon lang nicht mehr da QUOTE Der aufmerksame Beobachter wird dabei feststellen, daß er das irgendwoher kennt klär mcih bitte auf - woher kenn ich das? ich muss mich da vor lauter neugier jetzt outen

Manuel	Geschrieben am: 04. Sep 2005 - 13:09
Unregistered	QUOTE Eine Idee meinerseits wäre, wenn wir das Handbuch so aufbauen wie auf php.net, d.h. mit Kommentarfunktion. (denn auch eine Doku kann nicht alles beinhalten) Grundsätzlich bin dafür. Allerdings sollte man die Kommentarfunktion auf einen bestimmten Benutzerkreis beschränken. Einfach deshalb um zu verhindern, daß jeder evtl. seinen Käse reinschreibt und das ganze zu einem zweiten Forum verkommt. Evtl. könnte man die Möglichkeit an den Nutzerstatus oder Anzahl der Beiträge aus dem Forum binden um eine gewisse Qualität der Beiträge sicherzustellen. Bitte jetzt nicht falsch verstehen. QUOTE Man könnte sogar soweit gehen, dass man jede Seite des Backends nachbildet und die darauf erscheinenden Symbole/Elemente/Texte mit Links zu Seiten versieht die in gleicher Ansicht die entsprechend Hilfseite einblendet Entweder hast du mich falsch verstanden oder ich dich jetzt: Also ich meinte schon, daß die aus dem BE bekannte Navigation oben mit Funktion versehen ist, dh. es gibt min. drei Navibereiche: die Nachbildung der BE-Navi im oberen Bereich (Top-Kat und Ordner) und die Kapitelnavi links (Ordner und Seiten im aktiven Ordner). Auf den Startseiten eines jeden Kapitels könnte dann eine Nachbildung des BE erscheinen, wobei die einzelnen Elemente mit den dazu passenden Hilfeseiten verlinkt sind. Das bedeutet aber eine Menge arbeit, die sich bei jeder grundlegenden Änderung des BE wiederholt. Aussehen könnte das dann etwa so: QUOTE Ich bin mir nicht sicher aber ich glaub hier geht es um ein statisches Handbuch welches dann zwar auch vom Web aus ereichbar sein würde, aber auch dem Download beiliegen sollte. So sehe ich das auch. Mit geeigneten Tools ist es ja problemlos möglich die Seite als statische Seiten zu grabben und als HTML-Doku mitzuliefern - die Suche würde dann natürlich nicht funktionieren. QUOTE das hauptproblem seh ich - wie olaf - in den neuentwicklungen von dedi. wie wollen wir ein handbuch aufbauen, dass es für änderungen offen bleiben kann, ohne die gesamtstruktur und aussehen ändern zu müssen. Das verstehe ich jetzt nicht - schließlich setzen wir das Handbuch mit einem CMS um. Wenn also neue Funktionen in DeDi integriert werden, dann braucht's dazu nicht mehr als im Handbuch einen oder mehrere neue Ordner anlegen und die entsprechenden Hilfeseiten dazu verfassen. Sollten irgendwelche Funktionen zukünftig woanders angesiedelt werden (bspw. Stylesheet wäre im Bereich Redaktion), dann wird einfach der Ordner im Handbuch-CMS umgehängt. Einzig die Änderung des komplette BE-Layouts wäre etwas umfangreicher aber auch nicht unmöglich, da wir ja immer noch mit einem CMS arbeiten. QUOTE wir bauen den unteren bereich wie man es sieht als webseite wo man sich durchklicken kann. dies ganze allerdings wird zusätzlich in ein plugin gepackt, welches bei einer neuinstallation mit dabei ist. sobald der user jetzt so weit ist das er die hilfe nicht mehr benötigt kann er sie einfach deinstallieren. Die Idee ist natürlich auch super. Viel braucht's dazu gar nicht. Lediglich ein vorinstalliertes Plugin (sind ja nur ein paar Einträge in der DB) und den jeweils aktuellen HTML-Export des Online-Handbuchs. Unter Verzicht auf eine Suchfunktion (wie schon oben angesprochen) absolut kein Problem. QUOTE ich dachte bezüglich neuentwicklung vor z. b. an die screenshots. die müßte man dann halt immer neu machen, falls sich optisch was an den dialogen ändern sollte. Meine Erfahrung zeigt, daß damit so ziemlich jede freie (und kostenlose) Software zu kämpfen hat. Programmiert wird immer gerne und schnell nur am schreiben der Doku hat keiner richtig Spaß, weshalb diese oft vernachläßigt wird. @mika QUOTE klär mcih bitte auf - woher kenn ich das? ich muss mich da vor lauter neugier jetzt outen Wann hast du dich zum letzten mal in einem DeDi-Backend eingeloggt? Scheint schon länger her zu sein Manuel

visioncom	Geschrieben am: 04. Sep 2005 - 16:27
Member Gruppe: Members Beiträge: 276 Mitgliedsnummer: 686 Mitglied seit: 29. Jul 2004	Hallo Zusammen Sorry das ich mich jetzt auch noch einmische! Ich finde man sollte die erstellung des Handbuchs in zwei Bereiche gliedern. Ein Teil sollte den Corebereich abdecken der aus meiner sicht ziemlich Statisch sein könnte. Jedoch der Modul- und Pluginbereich sollte meiner meinung nach ziemlich dynamisch laufen. Das heisst mit der veröffentlichung der Module bzw. Plugin sollte zugleich die Dokumentation abgeliefert werden. Den ansonsten gibt es immer Undokumentierte Leichen. Und die Aufzuarbeiten finde ich zu zeitraubend. Diese Zeit würde man doch besser in die Weiterentwicklung oder Neuentwicklung investieren. Wie das gesamte funktioniert mit der Dynamik kann man auf verschiedene Wege lösen. Das mit der Onlinedoku und dem Plugin finde ich ne toole Idee. Guss Chris PS: Einwichtiger Punkt bleibt aber immer -> Die Kontrolle der Dokus (Qualitätskontrolle)

summerbrother	Geschrieben am: 04. Sep 2005 - 18:14
Klugscheisser Gruppe: Members Beiträge: 385 Mitgliedsnummer: 455 Mitglied seit: 26. Jan 2004	Manuel hat das schon ganz gut erklärt, find ich toll die Idee. Meine persönliche Meinung: Ich finde die Darstellung wichtig jedoch nicht rudimentär entscheident für die Qualität einer Doku. Für mich ist das Forum die beste Doku, wenn auch manchmal etwas unübersichtlich, aber mit ein bischen Mühe findet man doch fast alles. Viel wichtiger finde ich die Verteilung von Verantwortlichkeiten. Die sind mir nicht bekannt, oder einfach an mir vorbeigezischt. Warum können wir nicht thematisch aufteilen ? Mit einem Namen, z.B. Olaf ist verantwortlich für alles was Css angeht, Peter für alles was Contentflex und BBcode angeht, usw. (Die Namen sind willkürlich gewählt und entsprechen meinen persönlichen Geschmack) Dementsprechend kann auch das Forum in der Moderation aufgeteilt werden und aus dem was dort passiert eine Doku erstellt und gepflegt werden. Das funktioniert in anderen Foren auch. Jeder der verantwortlichen kann sich ja "Gehilfen" holen, die ihm helfen, den Wust zu erledigen. Was mir halt fehlt ist immer ein echter Ansprechpartner. Als Bsp.: Ich bekomme in letzter Zeit öfters Anfragen von Newbies per PM, ob ich irgendwo helfen kann. Bis das alles ausgekaspert ist und es endlich an die Hilfe geht, sind etliche PMs und Mails geschrieben. Mittlerweile könnt ich ne Doku schreiben für Newbies. Warum hab ich das eigentlich noch nicht gemacht ?? ich fühl mich nicht dafür verantwortlich und warte mal, ob einer fragt. Wenn jetzt als Beispiel Olaf (entschuldige, das ich dich immer rannehme) alle Anfragen die er bekommt, einfach mal in sein Thema "CSS und DEDI" packen würde, könnten wir alle ne Menge lernen und er hätte viele Frage nicht doppelt. Ich hoffe, ich konnte klar machen, wie ich das sehe, und vielleicht interessierts auch wen. gruss achim

hk-cons	Geschrieben am: 04. Sep 2005 - 18:30
Dauertester Gruppe: Tester Beiträge: 5444 Mitgliedsnummer: 71 Mitglied seit: 31. Mar 2003	QUOTE Warum hab ich das eigentlich noch nicht gemacht ?? ich fühl mich nicht dafür verantwortlich und warte mal, ob einer fragt. gute idee ... auftrag erteilt .... QUOTE könnten wir alle ne Menge lernen und er hätte viele Frage nicht doppelt. lernen schon, aber das mit den doppelten fragen ..... ich bezweifele es aus eigener fragenbeanwortung -------------------- spart sich sprüche und wird humorlos

summerbrother	Geschrieben am: 04. Sep 2005 - 18:39
Klugscheisser Gruppe: Members Beiträge: 385 Mitgliedsnummer: 455 Mitglied seit: 26. Jan 2004	QUOTE aber das mit den doppelten fragen ..... wieso ?? du selber hast mal eine ganze zeit penetrant auf den Link verwiesen und mein Eindruck war, das das geholfen hat oder täuscht das.... wer einmal unter deine Räder gekommen ist, dem passiert das nie wieder QUOTE gute idee ... auftrag erteilt .... Ok, gib mir unter Der Dirigent » Support im Forum einen Thread "Für Anfänger" und Moderatorrechte für die Ecke. Und schick die Newbies mal dahin. Mal schauen was daraus wird. Gruss achim

Eppi	Geschrieben am: 04. Sep 2005 - 18:40
.....................noname Gruppe: Admin Beiträge: 8077 Mitgliedsnummer: 1 Mitglied seit: 23. Mar 2003	also das mit dem nachbau das backens finde ich zwar schön ung gut - auch recht benutzerfreundlich, jedoch wird man sich dies dann nicht ausdrucken können. ich finde also eine hilfe die wir wie ein richtiges buch schreiben wesentlich besser. mir geht es auch darum, das man dies später in einer gedruckten form anbieten könnte oder es sich jeder ausdrucken kann der dedi nicht unbedingt am rechner erlernen will. trotzdem können wir dazu ja dieses plugin schreiben, welches dann direkt auf das passende thema verlinkt. das mit den verantwortungen halte ich für auch ganz wichtig. ich mcöhte also das wir für verschiedene bereiche personen festlegen die sich für diesen bereich verantwortlich fühlen. diese sollten dann einen eigenen thread im forum aufmachen und sich leute suchen mit denen sie dann diesen bereich abarbeiten. dann können sie diesen bereich veröffentlichen in diesem thread auch gleichzeitig kritik der anderen entgegennehmen und daran weiterarbeiten. die dokus für die module und plugins würde ich wie ein anhang in einem buch gestalten. also einfach die entsprechenden bereiche, die jetzt im wiki dafür schon angelegt sind und von der hoepage aus verknüpft sind mit inhalt füllen. gruß, paul -------------------- "Heute ist nicht aller Tage... ich komm wieder, keine Frage!"

Eppi	Geschrieben am: 04. Sep 2005 - 19:00
.....................noname Gruppe: Admin Beiträge: 8077 Mitgliedsnummer: 1 Mitglied seit: 23. Mar 2003	was haltet ihr davon wenn wir erstmal im wiki eine seite erstellen wo sich jeder eintragen kann der mitmachen will und welchen bereich er sich vorstellen könnte oder ob es ihm egal ist? bzw. seine stärken und schwächen reinschreiben. für den modulbereich reichen mir 2 leute. würde in diesem bereich den anführer spielen (da ich sowieso durch die einzelnen module muß). die anderen bereiche sollten wir dann aufteilen. @mika: könntest du für die planung im wiki eine seite einrichten? gruß, paul -------------------- "Heute ist nicht aller Tage... ich komm wieder, keine Frage!"