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]