Wiki-Seite anlegen
Vorbereitungen
Zunächst ist es wichtig, dass der Benutzer einen Wiki-Account besitzt und eingeloggt ist. Das ist wichtig, um Änderungen besser nachvollziehen zu können.
Namen aussuchen
Die Wahl des Namens für einen neuen Artikel ist ausgesprochen wichtig. Angenommen Sie möchten über die Ruby-Bibliothek xmpp4r schreiben, so wäre der korrekte Name - ganze einfach - xmpp4r. In dem Fall ist der Namen eindeutig und zukünftige Konflikte mit gleichnamigen Anleitungen können ausgeschlossen werden. Es gibt aber auch Ausnahmen. Der Name Key-Login ist nicht eindeutig genug für einen Artikel über das Authentifizierungverfahren via Public Key mit SSH. Hier sollte der Seitenname Key-Login (OpenSSH) heißen.
Regeln
- Die Anleitungen sollten so weit wie möglich in der dritten Person von einem Benutzer sprechen. Der Begriff »Benutzer« ist dabei dem Begriff »Kunde« vorzuziehen.
- Der Benutzer sollte mit »Sie« angesprochen werden
- Bei der männlichen Form ist das weibliche Pendant immer mitgemeint. Bitte kein Binnenmajuskel oder Ähnliches.
- Versuchen Sie, so einfach wie möglich zu erklären. Vermeiden Sie »Tech-Speek«
Templates
Für die Vereinfachung von komplexen Markup-Konstrukten stehen einige Templates zu Verfügung
Vorlage:AlertBox
Diese Vorlage sollte für wichtige Hinweise in der Anleitung genutzt werden.
Verwendung
{{AlertBox |title=<titel> |content=<text> }}
Aussehen
Vorlage:Box
Diese Vorlage darf für einfach Boxen verwendet werden, wo sie dem Autor passgenau erscheinen.
=Verwendung
{{Box |title=<titel> |content=<text> |image=Alert.png }}
Aussehen
Syntax
Ständig aktualisiert wird die Bearbeitungshilfe der Wikipedia.