Hilfe:Leitfaden für Autoren
Aus Spieleprogrammierer-Wiki
(Unterschied zwischen Versionen)
| [gesichtete Version] | [gesichtete Version] |
K |
|||
| (34 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| − | In diesem Artikel sind die wichtigsten Richtlinien zusammengefasst, die du als Autor befolgen solltest. | + | [[Kategorie:Hilfe]] |
| + | In diesem Artikel sind die wichtigsten Richtlinien zusammengefasst, die du als Autor befolgen solltest, damit dein Artikel nicht unnötig viel nachbearbeitet werden muss. Zu ''technischen Fragen'', vor allem Formatierung des Artikels (Quellcode, Listen, Bilder, Tabellen), Verlinkung und Kategorisierung, lies dir bitte die [[Hilfe:Inhaltsverzeichnis|Artikel in der Hilfe]] durch. | ||
== Allgemeine Richtlinien == | == Allgemeine Richtlinien == | ||
| − | + | Bitte lies dir zunächst [http://de.wikipedia.org/wiki/Wikipedia:Wie_schreibe_ich_gute_Artikel diesen Wikipedia-Artikel über das Schreiben guter Artikel] durch. Was dort beschrieben ist, gilt prinzipiell auch für dieses Wiki. Das Wichtigste in Kurzform: | |
| − | + | ||
| − | Bitte lies dir | + | |
;Kopiere keine Texte! | ;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 Literatur-/Referenzenverzeichnis des Artikels an. | + | : Du darfst auf keinen Fall fremde Texte ohne Einverständnis des Autors kopieren, auch nicht auszugsweise. Setzte stattdessen ein Zitat, und lege dafür einen Eintrag im Literatur-/Referenzenverzeichnis des Artikels an. |
| − | ;Wähle ein relevantes Thema mit Bezug zur | + | ;Wähle ein relevantes Thema mit Bezug zur Website! |
| − | : 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''. | + | : 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''. Siehe auch [[SpproWiki:Über|hier]]. |
| + | |||
| + | ;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. Ein häufiger Fehler ist das Weglassen von Bindestrichen: Während man im Englischen von "3D graphics" spricht, heißt es auf Deutsch "3D-Grafik" und ''nicht "3D Grafik"''. | ||
;Wähle einen passenden Titel! | ;Wähle einen passenden Titel! | ||
| Zeile 20: | Zeile 22: | ||
;Baue deinen Artikel logisch auf! | ;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 | + | : 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: Was ist das Ziel des Artikels? An wen richtet er sich? Was darf der Leser erwarten? Nutze außerdem Überschriften und Unterüberschriften, um die Inhalte zu gliedern. Übertreibe es aber nicht. Wenn ein Abschnitt nur aus einem einzigen Absatz besteht, benötigt er normalerweise keine eigene Überschrift. |
;Verlinke andere Artikel/Webseiten und gib Quellen an! | ;Verlinke andere Artikel/Webseiten und gib Quellen an! | ||
: Verweise an passenden Stellen auf [[Hauptseite|andere Artikel des Wikis]] oder [http://www.spieleprogrammierer.de/ 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<ref>David Scherfgen: ''3D-Spieleprogrammierung. Modernes Game Design mit DirectX 9 und C++.'' 3. Auflage. Hanser Verlag, München 2006.</ref>. | : Verweise an passenden Stellen auf [[Hauptseite|andere Artikel des Wikis]] oder [http://www.spieleprogrammierer.de/ 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<ref>David Scherfgen: ''3D-Spieleprogrammierung. Modernes Game Design mit DirectX 9 und C++.'' 3. Auflage. Hanser Verlag, München 2006.</ref>. | ||
| − | ; | + | ;Ordne deinen Artikel Kategorien zu und verlinke ihn auf anderen Seiten! |
| − | : | + | : Dein Artikel wird leichter gefunden, wenn ihn Kategorien zuordnest. Eine Liste aller Kategorien findest du [[Spezial:Kategorien|hier]]. Du ordnest einem Artikel eine Kategorie zu, indem du (vorzugweise am Anfang des Artikels) eine Zeile wie "<tt><nowiki>[[Kategorie:Tutorial]]</nowiki></tt>" einfügst. Diese Zeile würde den Artikel der [[:Kategorie:Tutorial|Kategorie "Tutorial"]] zuordnen. Außerdem solltest du in anderen Artikeln oder Übersichtsseiten an passenden Stellen auf deinen Artikel verweisen. |
;Benutze Bilder zur Erklärung komplizierterer Sachverhalte! | ;Benutze Bilder zur Erklärung komplizierterer Sachverhalte! | ||
| Zeile 36: | Zeile 38: | ||
;Schreibe neutral! | ;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. | : Sieh davon ab, Formulierungen wie "das beste", "das einfachste" etc. zu benutzen. Schreibe wertneutral. Der Leser soll sich seine eigene Meinung bilden können. | ||
| − | |||
| − | |||
| − | |||
;Nenne dich nicht als Autor eines Artikels! | ;Nenne dich nicht als Autor eines Artikels! | ||
: Die Idee eines Wikis ist, dass die Inhalte von jedem erweitert, ergänzt oder geändert werden können. Darum nenne dich nicht als Autor eines Artikels! Wenn ein Leser wissen möchte, wer welchen Teil zu einem Artikel beigetragen hat, dann kann er dies durch Ansehen der Versionsgeschichte herausfinden. | : Die Idee eines Wikis ist, dass die Inhalte von jedem erweitert, ergänzt oder geändert werden können. Darum nenne dich nicht als Autor eines Artikels! Wenn ein Leser wissen möchte, wer welchen Teil zu einem Artikel beigetragen hat, dann kann er dies durch Ansehen der Versionsgeschichte herausfinden. | ||
| − | |||
| − | |||
| − | |||
;Schreibe nicht in der ersten Person Singular! | ;Schreibe nicht in der ersten Person Singular! | ||
| Zeile 52: | Zeile 48: | ||
Darüber hinaus solltest du folgende Hinweise beherzigen, die vor allem für Artikel in unserem Wiki wichtig sind: | Darüber hinaus solltest du folgende Hinweise beherzigen, die vor allem für Artikel in unserem Wiki wichtig sind: | ||
| + | |||
| + | ;Stelle den Code nicht in den Mittelpunkt deines Artikels! | ||
| + | : Versuche die ''Idee'' von Dingen zu beschreiben. Programmiersprachen und Bibliotheken ändern sich mit der Zeit. Eine Idee ist unabhängig von Code und bleibt daher viel länger gültig bzw. nachvollziehbar. Ein Artikel sollte zunächst immer die Funktionsweise von Dingen beschreiben, und zwar möglichst unabhängig von konkretem Code. Natürlich kann bei Bedarf eine Beispielimplementierung oder eine Liste von Tipps zur Implementierung folgen. Auf dem Code sollte aber nicht der Hauptfokus eines Artikels liegen (hier gibt es natürlich Ausnahmen bei extrem technischen Artikeln). | ||
| + | |||
| + | ;Beschreibe verschiedene Ansätze mit ihren Vor- und Nachteilen! | ||
| + | : Versuche möglichst viele Aspekte einer Fragestellung zu beleuchten. Welche Vorgehensweisen gibt es? Welche Vor- und Nachteile haben diese? So kann sich der Leser seine eigene Meinung bilden, die für ihn am besten geeignete Vorgehensweise finden und das Beschriebene selber umsetzen. | ||
| + | |||
| + | ;Versuche Konzepte unabhängig von der Programmiersprache zu erklären! | ||
| + | : Damit möglichst viele Leser deinem Artikel folgen können, solltest du versuchen, Konzepte möglichst unabhängig von einer bestimmten Programmiersprache zu erklären. Benutze ggf. [http://de.wikipedia.org/wiki/Pseudocode Pseudocode], um Algorithmen zu beschreiben. | ||
| + | |||
| + | ;Sprich den Leser mit "du" an! | ||
| + | : In der Spieleprogrammierer-Community sprechen wir uns mit "du" an. Bitte befolge dies auch in deinen Artikeln (nicht "Sie" oder "Ihr"), damit die Website in dieser Hinsicht einheitlich bleibt. | ||
;Folge einem guten Programmierstil! | ;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''. | + | : 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. Vermische bitte nicht deutsche und englische Bezeichner im Code! 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''. |
;Formatiere Code-Blöcke und Code-Elemente im Fließtext! | ;Formatiere Code-Blöcke und Code-Elemente im Fließtext! | ||
| − | : Benutze das <tt><nowiki>source</nowiki></tt>-Tag (siehe [[Hilfe:Quellcode_darstellen]]), um Code-Blöcke zu formatieren. Wenn du dich im Fließtext auf Variablen, Klassen, Funktionen, Methoden, Dateien etc. beziehst, formatiere diese bitte mit dem <nowiki><tt></nowiki>-Tag! Beispiel: "Die <tt>Vector</tt>-Klasse bietet eine Methode namens <tt>length</tt>, die die Vektorlänge berechnet." | + | : Benutze das <tt><nowiki>source</nowiki></tt>-Tag (siehe [[Hilfe:Quellcode_darstellen|Hilfe-Artikel]]), um Code-Blöcke zu formatieren. Wenn du dich im Fließtext auf Variablen, Klassen, Funktionen, Methoden, Dateien etc. beziehst, formatiere diese bitte mit dem <tt><nowiki><tt></nowiki></tt>-Tag! Beispiel: "Die <tt>Vector</tt>-Klasse bietet eine Methode namens <tt>length</tt>, die die Vektorlänge berechnet." |
== Anlegen und Verlinken einer neuen Seite == | == Anlegen und Verlinken einer neuen Seite == | ||
| Zeile 63: | Zeile 71: | ||
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. | 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. | + | 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. Solange der Artikel noch nicht fertig ist, bitte füge das "Baustelle"-Template hinzu, indem du folgende Zeile an den Anfang des Artikels schreibst: |
| + | |||
| + | <nowiki>{{Baustelle}}</nowiki> | ||
| + | |||
| + | Im Artikel sieht das dann wie folgt aus: | ||
| + | |||
| + | <div class="warning"> | ||
| + | '''Bitte beachte, dass dieser Artikel noch unvollständig ist!''' Hilf mit, ihn fertigzustellen.<br /> | ||
| + | Näheres dazu findest du ggf. auf der [[{{TALKPAGENAME}}|Diskussionsseite]]. Wenn du der Meinung bist, dass der Artikel vollständig ist, kannst du diesen Hinweis entfernen. | ||
| + | </div> | ||
| + | |||
| + | Außerdem solltest du deinen Artikel Kategorien zuordnen, wie schon weiter oben beschrieben. | ||
| + | |||
| + | === Artikel entwickeln auf einer Unterseite deiner Benutzerseite === | ||
| + | |||
| + | Wenn du deinen Artikel nicht sofort öffentlich zugänglich machen möchtest, dann lege ihn unter deiner Benutzerseite ab. Klicke dazu oben in der Kopfzeile ganz links auf den Link mit deinem Benutzernamen, um zu deiner Benutzerseite zu gelangen. Du kannst auch Unterseiten erzeugen und dort deinen Artikel anfangen zu schreiben. Wenn du denkst, dass die Grundstruktur des Artikels fertig ist, dann kannst du ihn von dort aus ''verschieben''. Durch das Verschieben bleiben die Versionsgeschichte und die Diskussionseite erhalten. Ein Beispiel für eine Unterseite: [[Benutzer:David Scherfgen/Beispiel für eine Unterseite]]. Bitte beachte, dass andere Benutzer bei dieser Vorgehensweise deinen Artikel nicht bearbeiten bzw. verbessern können (lediglich über die Diskussionsseite). | ||
| − | == | + | == Einzelnachweise == |
<references /> | <references /> | ||
Aktuelle Version vom 20. Dezember 2013, 13:14 Uhr
Klicke hier, um diese Version anzusehen.
