"Widmann, Manfred Dipl.-Ing." <[EMAIL PROTECTED]> schrieb im Newsbeitrag news:[EMAIL PROTECTED] > "Christian Wolff" <[EMAIL PROTECTED]> schrieb im Newsbeitrag > news:[EMAIL PROTECTED] > > Am Mon, 14 May 2007 15:15:09 +0200 hat Widmann, Manfred Dipl.-Ing. > > <[EMAIL PROTECTED]> geschrieben: > > > >> Ich hab mir jetzt einmal Gedanken gemacht, wie eine Extension Doku > >> aussehen > >> sollte, wenn ich sie verwenden würde: > >> ---------------------- > >> Result > >> - Screenshot > >> - Description (as given in Extension Repository; opt. more details) > >> > >> Installation > >> - Prerequisits > >> -- TYPO3 Version > >> -- Other Ext.: Name, Version > >> - Process > >> > >> Configuration / Adaption > >> - TypoScript - Objects: Name, Description, Default Value (Static Include, > >> PHP) > >> - Subparts & Marker: Name, Description, Content (e.g.) > >> > >> Known Poblems > >> > >> Change List: Version, Change (as given in Extension Repository) > >> ------------------------- > >> > >> Was hälts davon? > >> > >> lg > >> Manfred > >> > > > > hi Manfred > > ist das nicht mehr oder weniger die strucktur der Template Vorlage? > > http://typo3.org/extensions/repository/view/doc_template/0.0.1/
Mein Manko zu diser Vorlage: da ist immer noch nicht das aktuelle Logo drin ;-) > Leider nein ... da ist so viel Balast dabei ... was versteht man > beispielsweise unter "Administration"? Wer ist der "user", für wen ist das > User Manual gedacht? Der, der das Frontend sieht oder der, der das Backend > verwendet oder der, der die Ext installiert? Sind alles User ... undundund! > Und: Wozu ein (immer gleiches) Tutorial ... > > Wie gesagt, für mich ist die Vorlage ein Greul ... und eigentlich möchte ich > die Absolution, dass meine Struktur eh auch in Ordnung ist ... Deine Struktur ist vermutlich in Ordnung, denn eigentlich gibt es nicht so viel zu beachten. um mal zu deinen verschiedenen Usern zu kommen: natürlich sind das alles irgendwo 'user' aber in verschiedenen Rollen und damit u.U. mit unterschiedlichen Rechten. Da gibt es die Admins, die das Recht haben eine Extension zu installieren da gibt es Redakteure, mit Typoscript-Zugriff, die Konfigurieren dürfen/müssen, aber auch Seiten für Datensätze anlegen müssen dann die Content-Redakteure, die Inhalte einpflegen, und z.b. auch Datensätze anlegen müssen, .... dazwischen dann noch Redakteure, die z.B.. ein Plugin einfügen und Seitenspezifisch konfigurieren Und bei manchen Extensions natürlich auch die FE-User (Seitenbesucher, die evtl. das eine oder andere mit der Extension interagieren (z.b. Foreneinträge) Jeder dieser User braucht etwas andere Informationen und braucht vor allem nicht all die Informationen des nächsthöheren. da es aber manchmal übergreifend ist darf auch mal ein Teil doppelt in der Doku drin sein. Am wichtigsten (für mich) aber: bitte alle Parameter, an denen ich von außen (Außerhalb des PHP-Codes) drehen kann dokumentieren. Am Besten mit Beispielen. ;-) Ansonsten kann erstmal nur der Extensionentwickler wissen wer welches Wissen über die Extension haben muss. manch eine Extension wird einfach nur installiert und das war es. und bei anderen braucht man vielleicht sogar mehr Rechte als ein normaler Admin (Install-Tool, FTP, SSH, ...) das sollte sich im Handbuch widerspiegeln. Bernd -- www.bernd-wilke.net _______________________________________________ TYPO3-german mailing list [email protected] http://lists.netfielders.de/cgi-bin/mailman/listinfo/typo3-german
