Papoo Dokumentation:Hilfe

Version vom 02:15, 22. Feb 2006

Dieses Dokument soll Hilfestellung für erste Schritte leisten, um das Wiki für die Papoo Dokumentation zu erweitern und so viele Exzellente Artikel wie möglich zu erstellen.

Praktische Tipps

• Bilder hochladen
• Dazu gibt es diese Tipps zur Bilderbearbeitung
• Bilder in den Text einbinden
• Syntax und Textgestaltung

Grundsätze

• Unter jede Überschrift gehört ein Text bzw. eine Einleitung
• Schreibe sachlich, neutral und in ganzen Sätzen
• Benutzt soviel wie möglich leichte Sprache
• Bei technischer Dokumentation sind Bilder zur Auflockerung hilfreich
• Es sollten unbedingt die Formatvorlagen beachtet werden

Ausführliche Anleitung

Wie man an den exzellenten Artikeln beim Wikipedia sehen kann, werden alle Artikel mit einem kurzen Text eingeleitet (Beispiel: Vertrauensfrage).

Das Wikipedia ist eine der erfolgreichsten Webseiten überhaupt, demnach ist es sinnvoll, sich an den Richtlinien "Wie schreibe ich gute Artikel?" zu halten. Wenn sich jeder an diese Richtlinien hält, werden wir gemeinsam in diesem Wiki eine hervorragende Dokumentation auf die Beine stellen. Wichtig sind vor allem die Punkte:

• Verständlichkeit
• Begriffsdefinition und Einleitung
• "Überschriften und Absätze": Das Benutzen von Doppelpunkten in Überschriften sollte ebenfalls vermieden werden.
• Unterkategorien, wenn sie nicht zu umfangreich sind, sind oft im Hauptartikel besser aufgehoben. (siehe dazu das Thema "Verlinken"). Das beweist auch der unten genannte Artikel von Tolkien.

Struktur eines Artikels

Gute Strukturen haben die Artikel:

• Template Engine
• J.R.R. Tolkien

Wie man bei Tolkien sehen kann, ist die Einführung sehr kurz und danach beginnt Inhaltsverzeichnis und Überschrift. Wie man auch sieht, ist der Artikel sehr lang.

Zitat aus einer Mail:

Folgende Richtlinien habe ich im Wikipedia gelernt:
- Alles was zu einem Thema gehört, wird auf einer Seite beschrieben (zur
Person Tolkien => alles unter Tolkien)
- Ab 10 bis 15 Druckseiten sollte man sich Gedanken machen, ob man nicht
eine Übersichtsseite macht (siehe Wiki-Hauptseite von Papoo) und dann
Unterbereiche macht
- Würde man die drei Bände des "Herr der Ringe" unter "Tolkien" beschreiben,
wäre das für mich Off-Topic. Er hat die Bücher zwar geschrieben, aber sie
gehören nicht in die Kategorie "Person" sondern unter "Bücher".
- Ebenso ist es bei den Template Engines: Jede allgemeine Beschreibung und
Erweiterung muss dort hinein. Eine spezielle Template Engine wie Smarty
(http://de.wikipedia.org/wiki/Smarty) bekommt eine extra Seite

Demnach schreibt man zuerst alles untereinander, weil es später kein Problem ist, eine Übersichtsseite zu erstellen, mit Unter-Artikeln. Das gilt aber nicht für den Bereich Frontend, denn da ist es schon entschieden worden. Der Frontendbereich verweist schon jetzt auf Unterartikel, also sollte diese Struktur beibehalten werden.

Wenn jemandem von Anfang an klar ist, dass ein neuer Bereich so groß wird (wegen Bilder und Text), dass er den Rahmen eines Artikels sprengen würde, dann bietet sich direkt eine Übersichtsseite an. Wie man allerdings an Tolkien sehen kann, sind wir in vielen Bereich noch nicht soweit, denn Tolkien hat mehr Überschriften und mehr Text als viele unserer Artikel hier im Papoo-Wiki.