Hilfe:Leitfaden für Autoren

Aus Spieleprogrammierer-Wiki
Wechseln zu: Navigation, Suche

In diesem Artikel sind die wichtigsten Richtlinien zusammengefasst, die du als Autor befolgen solltest.

Inhaltsverzeichnis

[Bearbeiten] Allgemeine Richtlinien

Zu technischen Fragen, vor allem Formatierung des Artikels (Quellcode, Listen, Bilder, Tabellen) und Verlinkung, lies dir bitte die Artikel in der Hilfe durch.

Bitte lies dir anschließend diesen Wikipedia-Artikel über das Schreiben guter Artikel durch. Was dort beschrieben ist, gilt prinzipiell auch für dieses Wiki. Das Wichtigste in Kurzform:

Kopiere keine Texte!
Du darfst auf keinen Fall fremde Texte kopieren, auch nicht auszugsweise. Setzte stattdessen ein Zitat, und lege dafür einen Eintrag im Literaturverzeichnis des Artikels an.
Wähle ein relevantes Thema mit Bezug zur Webseite!
Dies ist ein Wiki für Spieleentwickler. Alle Artikel sollten einen Bezug zur Spieleentwicklung haben. Es gibt bereits genügend allgemeine Tutorials zum Programmieren. Wenn du also beispielsweise einen Artikel über objektorientierte Programmierung schreiben möchtest, dann fokussiere dich auf die Einsatzmöglichkeiten objektorientierter Programmierung in der Spieleentwicklung.
Wähle einen passenden Titel!
Gib deinem Artikel einen aussagekräftigen und zum Inhalt passenden Titel, so dass der Leser schon sofort eine ungefähre Vorstellung davon hat, wovon der Artikel handelt.
Schreibe verständlich und richtig!
Schreibe deinen Artikel so, dass er von einem durchschnittlichen Leser der Zielgruppe ohne Probleme verstanden werden kann. Lege außerdem hohen Wert darauf, dass die Aussagen in deinem Artikel korrekt sind.
Baue deinen Artikel logisch auf!
Ein Artikel beginnt mit einer Einleitung, in der kurz erklärt wird, wovon dieser Artikel handelt. Falle nicht gleich mit der Tür ins Haus, sondern führe den Leser an das Thema heran. Nutze Überschriften und Unterüberschriften, um die Inhalte zu gliedern.
Verlinke andere Artikel/Webseiten und gib Quellen an!
Verweise an passenden Stellen auf andere Artikel des Wikis oder externe Webseiten, damit der Leser Anknüpfungspunkte hat oder die Definition eines Begriffs nachschlagen kann. Belege wichtige oder übernommene Aussagen, indem du sie im Literaturverzeichnis referenzierst, so wie es hier demonstriert ist[1].
Benutze Bilder zur Erklärung komplizierterer Sachverhalte!
Ein Bild sagt bekanntlich oft mehr als 1000 Worte. Setze Bilder dort ein, wo sie das Verständnis eines schwierigen Sachverhalts erleichtern können. Übertreibe aber nicht!
Schreibe neutral!
Sieh davon ab, Formulierungen wie "das beste", "das einfachste" etc. zu benutzen. Schreibe wertneutral. Der Leser soll sich seine eigene Meinung bilden können.
Achte auf Rechtschreibung, Grammatik, Zeichensetzung und Sprache!
Ein Artikel, der voller Rechtschreib-, Grammatik- und Zeichensetzungsfehlern ist, wirkt nicht besonders professionell und strapaziert den Leser. Darum benutze ein Wörterbuch oder eine Rechtschreibkorrektur, wenn du dir nicht sicher bist, wie etwas geschrieben wird. Benutze keinen Dialekt, keinen Slang und natürlich keine Vulgärsprache oder Schimpfwörter! Vermeide die Verben "tun" und "machen", verwende stattdessen differenziertere Verben.
Sprich den Leser mit "du" an!
Die Spieleprogrammierer-Community hat ein relativ niedriges Durchschnittsalter, so dass wir uns alle mit "du" ansprechen können. Bitte befolge dies auch in deinen Artikeln (nicht "Sie" oder "Ihr"), damit die Webseite in dieser Hinsicht einheitlich bleibt.
Schreibe nicht in der ersten Person Singular!
Ein Wiki-Artikel wird normalerweise von vielen Autoren bearbeitet/geändert. Darum ist es nicht angemessen, in der ersten Person Singular ("ich") zu schreiben. Sätze wie "Ich empfehle dir Visual C++ 2010." oder "Ich hatte am Anfang auch zuerst Probleme, das zu verstehen." sind in einem Wiki-Artikel nicht erwünscht. "Wir" ist hingegen eher akzeptabel.
Setze die Formatierungsmöglichkeiten sparsam ein!
Besonders wichtige Wörter oder Sätze sollten kursiv geschrieben werden, bitte nicht fett oder gar unterstrichen. Setze diese Formatierung sparsam ein! Wenn jedes zweite Wort hervorgehoben wird, verfehlt die Hervorhebung ihren Sinn.

[Bearbeiten] Seitenspezifische Richtlinien

Darüber hinaus solltest du folgende Hinweise beherzigen, die vor allem für Artikel in unserem Wiki wichtig sind:

Folge einem guten Programmierstil!
Wenn dein Artikel Beispiel-Code enthält, gib dir Mühe, deinen Code gut lesbar zu gestalten und ihn mit ausreichend vielen Kommentaren zu versehen. Verwende einheitliche Formatierung und Einrückung. Benenne Klassen, Schnittstellen, Variablen und Methoden nach einem einheitlichen und sinnvollen Schema. Versuche, deinen Code standardkonform zu halten, damit er auf möglichst vielen Plattformen funktioniert. Wir möchten dir nicht vorschreiben, welchem Stil du folgen sollst, aber sei konsistent.

[Bearbeiten] Anlegen und Verlinken einer neuen Seite

Wenn du die oben aufgeführten Richtlinien durchgelesen und verstanden hast, dann kannst du loslegen und deinen Artikel erstellen. Gib dazu den Titel deines Artikels oben rechts im Suchfeld ein, und klicke dann auf das Lupen-Icon. Vorausgesetzt, dass der Artikel nicht bereits existiert, wird dir dann ein roter Link präsentiert, der auf eine noch nicht vorhandene Seite verweist. Klicke diesen roten Link an, um mit dem Schreiben des Artikels zu beginnen.

Wichtig: Damit dein Artikel später auch von den Lesern gefunden wird, solltest du ihn in anderen Artikeln oder Übersichtsseiten verlinken. Wie man Links setzt, solltest du zu diesem Zeitpunkt bereits gelernt haben. Aber bitte tu dies erst dann, wenn sich der Artikel schon in einem zumutbaren Zustand befindet.

[Bearbeiten] Literaturverzeichnis

  1. David Scherfgen: 3D-Spieleprogrammierung. Modernes Game Design mit DirectX 9 und C++. 3. Auflage. Hanser Verlag, München 2006.
Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge