Hilfe:Leitfaden für Autoren

Aus Spieleprogrammierer-Wiki
(Unterschied zwischen Versionen)
Wechseln zu: Navigation, Suche
[gesichtete Version][gesichtete Version]
(Anlegen und Verlinken einer neuen Seite)
K
 
(8 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 9: Zeile 9:
 
: 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.
 
: 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 Webseite!
+
;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''. Siehe auch [[SpproWiki:Über|hier]].
 
: 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]].
  
Zeile 49: Zeile 49:
 
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:
  
;Sprich den Leser mit "du" an!
+
;Stelle den Code nicht in den Mittelpunkt deines Artikels!
: In der Spieleprogrammierer-Community sprechen wir uns mit "du" an. Bitte befolge dies auch in deinen Artikeln (nicht "Sie" oder "Ihr"), damit die Webseite in dieser Hinsicht einheitlich bleibt.
+
: 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).
  
;Folge einem guten Programmierstil!
+
;Beschreibe verschiedene Ansätze mit ihren Vor- und Nachteilen!
: 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''.
+
: 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!
 
;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.
 
: 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!
 +
: 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!
Zeile 80: Zeile 86:
 
=== Artikel entwickeln auf einer Unterseite deiner Benutzerseite ===
 
=== 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 der Artikel bereit für das Wiki ist, dann kannst du ihn von dort aus kopieren. Ein Beispiel für eine Unterseite: [[Benutzer:David Scherfgen/Beispiel für eine Unterseite]].
+
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).
  
== Referenzen ==
+
== Einzelnachweise ==
  
 
<references />
 
<references />

Aktuelle Version vom 20. Dezember 2013, 13:14 Uhr

Klicke hier, um diese Version anzusehen.

Meine Werkzeuge
Namensräume
Varianten
Aktionen
Navigation
Werkzeuge