Project:PD-Hilfe
 Projekt: PD Hilfe ist ein Projekt, um eine Reihe von übersichtlichen Benutzer-Hilfeseiten für MediaWiki Benutzer zu erstellen, d.h. für die Besucher einer Internetseite, die von MediaWiki betrieben wird. Das Projekt umfasst den gesamten Inhalt im Hilfe Namensraum. Die wichtigste Anlaufstelle dafür ist Hilfe:Übersicht. Diese Hilfe-Dokumentation ist getrennt vom Projekt:Handbuch (dass GFDL-lizenzierte MediaWiki Administrator-Handbuch). Mitwirkende, seien Sie sich bitte über die Unterschiede im klaren! Die Hilfeseiten der Gemeinfreiheit enthalten keine Informationen für Server-Administratoren, wie man installiert, konfiguriert oder wie man MediaWiki-Software wartet. Siehe den Abschnitt 'Ziel' weiter unten an, um eine ausführliche Erklärung zu erhalten, für das was wir versuchen zu erreichen.
|
Ziel
Die Idee ist es einen Satz von Hilfeseiten zu erstellen, welche man in eine frische MediaWiki-Installation kopieren kann oder dass diese Seiten mit der MediaWiki-Distribution ausgeliefert werden. Dies schließt grundlegende Benutzerinformationen und andere Metainformationen in einer recht kurzen Form ein. Das Basissystem sollte ein komprimierter Benutzerführer sein, und nicht eine bevorzugte Arbeitsweise darstellen. Es sollte sich auf die „Benutzerwünsche“ konzentrieren und andere Funktionen nicht erklären.
Lizenz
Die PD-Hilfe ist unter Public Domain freigegeben (anstatt wie üblich unter der CC0 waiver). Dies ist notwendig, damit man allen Leuten erlauben kann, den Text in ihre eigene Wikiinstallation zu kopieren. Stellen Sie bitte folgendes sicher, bevor Sie etwas hierzu beitragen:
- Jede Seite in der PD Hilfe muss folgenden Code
{{PD Help Page}}enthalten, um auf die Lizenz hinzuweisen. - Es dürfen keine Inhalte von anderen Orten auf diese Seiten kopiert werden. Die einzigen Ausnahmen sind:
- Der kopierte Inhalt stammt von dir selbst (z. B. als Autor) oder du hast eine dokumentierte Erlaubnis des ursprünglichen Autors (der ursprünglichen Autoren).
- Inhalt der bereits unter Public Domain steht, kann hierher kopiert werden; bedenke aber, dass die meisten Seiten dies NICHT sind!
- Bedenken Sie, das Sie alle Rechte zu den hier beigetragenden Informationen abgetreten haben. Obgleich man Ihre Beiträge hier Ihnen zuschreiben könnte, können andere den Text, ohne einen Hinweis zu geben, kopieren und ändern.
Zielgruppe: Normale Benutzer
Die Hilfeseiten werden häufig von den normalen Besuchern einer Wiki-Webseite aufgerufen.
Keine Server-Administratoren
Wir wollen nicht die gesamte MediaWiki-Dokumentation duplizieren. Informationen für Server-Administratoren, über die Installation, Konfiguration oder Entwicklung von MediaWiki gehören in das Handbuch.
Die einzige kleine Ausnahme hiervon sind die 'Admin-Tipps'-Boxen (unten beschrieben).
Informationen für Administratoren / Bürokraten weniger prominent
Die Hilfeseiten wären nicht vollständig, wenn sie nicht auch beschreiben würden, was 'Administratoren' können. Jedoch sind diese erweiterten Funktionen für den größten Teil der Zielgruppe (die meisten Wiki-Benutzer) nicht verfügbar. Daher sollten sich diese Informationen etwas abseits von dem Großteil der Inhalte befinden, damit normale Benutzer keine Informationen erhalten, die für sie nicht relevant sind.
Es kann nötig sein, auf den Hilfeseiten Aktionen kurz zu erwähnen, für die Administrator-Rechte erforderlich sind; ausführlichere Beschreibungen der Administrator-Tätigkeiten sollten jedoch auf weniger prominent verlinkte Seiten ausgelagert werden oder außerhalb der Hilfeseiten liegen.
Dieser Abschnitt wird diskutiert
Allgemeine Leitfäden
- Erstelle Links zwischen den Seiten, vermeide jedoch Links in andere Namensräume auf MediaWiki.org. Verwende interne Links innerhalb der Public-Domain-Hilfeseiten oder verwende externe Links (vollständige URLs), um auf relevante Seiten, z. B. auf meta.wikimedia.org, zu verlinken. Dies soll das Kopieren des Textes in eine frische Wiki-Installation vereinfachen. Nutze keine Interwikilinks, da diese im Zielwiki möglicherweise nicht existieren.
- Wir wollen nicht in die {{SITENAME}}-Sytax eintauchen. MediaWiki ist der Name der Software, die wir beschreiben. Dies ist die Content Management Software (CMS), die es dem Zielwiki ermöglicht, zu funktionieren. Daher sollte überall, wo wir auf die Software Bezug nehmen, auch MediaWiki zusammengeschrieben werden. Wenn der Hilfetext aus einem bestimmten Grund den Namen der Seite erwähnt, kann dies eine angemessene Ausnahme darstellen (nutze {{SITENAME}}). Trotzdem werden wir dies nicht überall verwenden, wo das Wort MediaWiki verwendet wird.
- Übersetzungen sollten erst erfolgen, nachdem die englische Version einen stabilen Status erreicht hat. Die Namenskonvention ist
Pagetitle/language-code(z.B. Help:Editing/de). - Bitte sieh vom Erstellen von Navigations-Vorlagen ab und konzentriere dich auf die Erstellung von Inhalten, es sei denn, du hast die perfekte Lösung für die Navigation innerhalb dieses Handbuchs.
- Nutze keine Erweiterungen wie Cite, da sie nicht auf allen MediaWiki-Installationen installiert sind.
Formatierung
- Die Formatierung sollte überall einheitlich sein. Benutzen Sie für einen Tabellenkopf den Code
class="wikitable", und für die Hervorhebung einer Zelle oder Zeile den Code{{Hl1}}. - Alle beschrieben Wikibefehle sollten in
<code>oder<pre>tags eingefasst werden. Ein Beispiel:{{subst:nw|text}}. - Alle Menü- und Beschreibungstexte sollten in Kursiv geschrieben werden.
Screenshots
Screenshots sind hilfreich. PD-Hilfe-Seiten sollen nur Public-Domain-Screenshots enthalten; vermeide Logos auf Screenshots und lade sie auf Commons mit den Lizenzvorlagen {{MediaWiki screenshot}} (für GPL) und {{CC-zero}} (für das Werk eines Benutzers) hoch.
Bilder werden zusammen mit der Dokumentation geliefert oder mit InstantCommons über Commons abgerufen.
Tipps für den Administrator
Wenn etwas in der Hilfe speziell für den Administrator angefertigt wurde, können Sie durch die Vorlage {{Admin tip}} direkt darauf hinweisen.
Kategorie
Alle Seiten im "Help:"-Namensraum sind per Definition Teil des Public-Domain-Hilfe-Dokumentations-Projektes und sollten in Kategorie:Hilfe kategorisiert sein. Hilfeseiten für MediaWiki-Erweiterungen sollten in die Unterkategorie Kategorie:Erweiterung-Hilfe kategorisiert werden.
Die ehemalige Kategorie für Seiten im "Help:"-Namensraum, dieses Public-Domain-Hilfe-Dokumentations-Projekt, war Category:PD help. Zur Vereinfachung heißt die Kategorie nun nur noch Kategorie:Hilfe und alle Seiten wurden aktualisiert.
Siehe auch
- Projekt:Sprachrichtlinie — Wenn du daran interessiert bist, an nicht englischen Versionen der Hilfeseiten zu arbeiten.
- Projekt:PD-Hilfe/export — Diskutiert eine vorgeschlagene Methode zur Erstellung verwendbarer Dumbs des Hilfe-Namensraums. Dies befindet sich noch im Diskussionsstadium und funktioniert noch nicht.