Styleguide

Aus OctoAwesome Wiki
Wechseln zu: Navigation, Suche

Hallo herzlich Willkommen im OctoAwesome Wiki und hier auf der Styleguide Seite. Hier sind kurz ein paar Tipps, Richtlinien und Regeln zusammengefasst, damit wir zusammen friedlich schreiben können und sich die Leser des Wikis auf das Wiki verlassen können

Warum das ganze?

In der Einführung wurde schon kurz die Gründe erklärt, das friedliche Miteinander und Standards für den Leser. Ich möchte es noch etwas genauer erklären. Wir sind eine Gemeinschaft von verschiedenen Menschen die an OctoAwesome mitarbeiten und Spaß daran haben. Doch es gibt bei solchen Projekten immer auch Ausreißer im positiven wie im negativen Sinne. Genau deshalb brauchen wir Regeln, damit wir nicht aneinander geraten und damit Tom, dessen Namen nunmal hinter dem Wiki steht, keine Schwierigkeiten bekommt. Warum ein Styleguide? Nun er wird nicht extrem ernst genommen aber er erfüllt zweierlei Zwecke, zum einen ist er ein kleiner Leitfaden anhand dem es sich für den ein oder anderen leichter schreiben lässt, zum anderen sollen sie die Artikel lesbarer machen und dem Leser einen Standard geben, damit dieser sich auf jeden Artikel verlassen kann.

Ich will mitschreiben

Wenn du bereits weißt, was du schreiben willst hast du sicher bereits die Suche bemüht und nachgesehen ob es bereits einen Artikel zu deinem Thema gibt, wenn nicht würde ich dir als erstes genau diesen Schritt empfehlen. Nicht nur um zu verhindern, dass wir hier ein Thema doppelt haben, sondern dass du dir auch nicht umsonst die Mühe machst, einen neuen Artikel zu schreiben. Außerdem sind wir alle sehr froh, wenn du einfach dein Wissen zu einem bereits vorhandenen Artikel beiträgst, damit wir alle voneinander noch etwas lernen.

Wenn du noch nicht weißt, wo du mitschreiben kannst, helfen drei Möglichkeiten: Überlege dir, was du besonders gut kannst und suche doch einfach mal nach diesen Themen, evtl. gibt es besonders kurze Artikel oder die Themen sind noch gar nicht vorhanden. Außerdem kannst du noch die Liste mit den gewünschten Seiten oder die Liste mit den zu überarbeitenden Artikeln durchsehen. Da ist sicher etwas dabei, wo wir dringend deine Hilfe benötigen

Recherche

Nachdem du nun weißt, wo und was du schreiben willst, gibt es verschiedene Ansätze loszulegen. Der sinnvollste und hier empfohlene Weg ist sich erstmal eine einfache Textdatei (.txt) anzulegen. Schreibe dir vllt. erstmal eine Überschrift auf was du schreiben willst. Und vllt. weist du sogar schon Abschnitte die du mit Leben füllen willst. So erhältst du einen guten Fahrplan für deinen Schreibprozess.

Als nächstes solltest du recherchieren, was weißt du bereits, wo bist du dir unsicher, wo musst du nachlegen. Merke dir am besten auch gleich alle Bücher und Internetlinks die du verwendest, die brauchst du nämlich noch.

Die einen recherchieren erst, die anderen schreiben gleich, wie auch immer du das willst. Aber wichtig ist, andere verlassen sich auf dich.

Schreiben

Beim tatsächlichen Schreiben bist du komplett frei in dem, was du schreibst. Jeder hat seinen eigenen Stil. Die einen schreiben sachlicher, die anderen mit einer guten Portion Humor. Generell solltest du darauf achten, dass dein Artikel leicht verständlich ist und die Rechtschreibung und Grammatik mehr oder weniger stimmt.

Als Tipp: Probiere doch einfach mal die Duden Textüberprüfung

Struktur

Nach dem du fleißig einen Text geschrieben hast, gilt es diesen zu strukturieren. Generell gibt es die grobe Vorlage, dass du einen kleinen Einführungstext schreibst. Er sollte in etwa zwei bis drei Sätzen das wichtigste so verständlich wie möglich auf den Punkt bringen, so dass man kurz nachgucken kann, was sa Thema bedeutet.

Am Ende eines Artikels findet man immer die Quellen und darunter evtl. eine Bildergalerie. Versuche dich daran zu halten. Zwischen Quellen und Einführungstext bist du aber in der Struktur frei. Achte aber darauf, dass es dir sinnvoll erscheint.

Wenn du nur einen Abschnitt geschrieben hast, gucke wo er in den bestehenden Artikel am besten reinpasst. Größere Abschnitte lassen sich durchaus auch noch weiter strukturieren.

Formatierung

Nach dem du einen Text hast, der strukturiert und geschrieben ist, kommt die "Arbeit" die Formatierung deines Meisterwerkes. Generell gelten die selben Grundsätze wie beim Kochen. Viel hilft viel und weniger ist mehr, die Kunst ist zu wissen, was wann gilt.

Wir achten hier bei der Formatierung darauf, dass es nicht zu viel ist, damit der User nicht erschlagen wird, aber bevor aber nicht formatiert wird, gibt es eben diesen Styleguide.

Überschriften

Generell sollen für die einzelnen Abschnitte Überschriften verwendet werden. Wenn deren Aussagen kräftig sind, umso besser. Achte auf die Überschriftenhierachie. Je mehr Gleichheitszeichen, desto weiter unten ist die Überschrift. Vermeide die Verwendung der ersten Überschrift (mit nur einem Gleichheitszeichen), diese ist für den Titel der Seite reserviert und wird automatisch generiert. Alle anderen Überschriften sind diese:

== ==
=== ===
==== ====

Hervorhebungen

Wichtige Wörter und Abkürzungen sollten fett formatiert werden, damit sie im Text direkt auffallen. Zu viel schwarzer Text ist aber nicht gut, also achte darauf, dass du damit sparsam umgehst. Nicht das uns die schwarze Farbe noch ausgeht ;)

Fremdwörter und Erklärungen sollten immer kursiv dargestellt werden, es sei denn sie sind fett oder verlinkt.

Abkürzungen

HDL, DLL, MFG, UTS, UKW, AKW, MPP, MDB etc. Sind alles Abkürzungen, doch was heißen die eigentlich? Du weißt das bestimmt, andere leider aber nicht. Deshalb tun wir ihnen den Gefallen und schreiben alle Abkürzungen mindestens einmal pro Artikel aus.

Hier eine kurze Liste von gebräuchlichen Abkürzungen.

HDL 
Hab dich Lieb
DLL 
Dynamic Link Library
MFG 
Mit freundlichen Grüßen
USB 
Universal Serial Bus
UKW 
Ultrakurzwelle
AKW 
Atomkraftwerk
WPF 
Windows Presentation Foundation
(G)UI 
(Graphical) user interface - (grafische) Benutzerschnittstelle
API 
Application programming interface - Programmierschnittstelle

Links

Jetzt wird's schwierig. Denn nach Möglichkeit sollten alle Themen, die es bereits als Artikel gibt, verlinkt werden. Wenn dir was untergeht, ist das halb so wild. Wenn du der Meinung bist ein Thema, z.B. WPF, sollte genauer erklärt werden, dann setze doch trotzdem den Link, auch wenn es vllt. noch keinen Artikel gibt. Es wird sich bestimmt jemand finden, der was dazu schreiben möchte.

Weblinks im Text kürzt du am besten mit einem Aussagekräftigen Stichwort ab. Eine Ausnahme bilden die Quellen.

Namen

Bei Namen bitte auf Korrektheit achten. Vorallem was Autoren angeht. Grundsätzlich geben die vorhandenen Artikel die Schreibweise vor.

Quellen

So, nachdem du jetzt einen schön formatierten Text hast, geht es an die Quellen. Es gibt eigentlich im Regelfall kaum eine Seite ohne Quelle und das hat gute Gründe. Zuerstmal das Recht. Wenn du zitierst, gibt es tatsächlich Gesetze, die dir sehr, sehr teuer zu stehen kommen können, wenn du dagegen verstößt, einfach kopieren geht schon mal garnicht. Und zweitens: Es geht auch um den Respekt der Person gegenüber, die deine Quelle verfasst hat, da steckt viel Mühe und Arbeit dahinter. Auch du möchtest nicht einfach kopiert werden, oder? Und drittens: Der Leser will evtl. nochmal etwas genauer nachsehen, dann kann er einfach die Quelle selber besuchen. Deshalb gibt es hier wirklich Gestaltungsregeln, damit hier keiner vor Gericht ein paar tausend Euro verliert. Wenn du nur einen Abschnitt verfasst hast, vergesse bitte nicht deine Quellen hinzuzufügen.

Weitere Hinweise:

  • Der Abschnitt „Quellen“ kommt immer gegen Ende des Textes und hat die Hauptüberschrifft „Quellen“.
  • Die Quellen sind in Unterüberschriften Weblinks und Literatur eingeteilt
  • Bitte nur Aufzählungen verwenden, keinen Fließtext
  • Weblinks nicht mit Wörtern abkürzen sondern immer imm Volltext verwenden, bespielsweise [http://wiki.octoawesome.net/wiki/Hauptseite http://wiki.octoawesome.net/wiki/Hauptseite]

Bücher immer komplett nennen, dass heißt

  • Titel und Untertitel
  • Autor
  • Verlag
  • Jahr bzw. Auflage
  • Hersteller wird mit Hrsg. abgekürtzt
  • Übersetzer müssen zwar nicht genannt werden aber auch die haben ganz schön viel Arbeit investiert
  • Und Nach möglichkeit bitte immer die ISBN angeben das erleichtert das Auffinden ungemein
  • Am besten auch noch Seitennummern

Zur Übersicht könnt ihr die Links und Literatur auch nach Sprachen sortieren, was sich aber nur bei einer großen Ansammlung lohnt.

Wichtig: lieber eine Quelle zuviel angegeben als eine zuwenig!

Namenskonvention

Nach demm jetzt der Artikel fertig ist, muss mann dem Kind noch einen Namen geben. Zuerst gucke bitte, wie man die Sache richtig schreibt. Ein bisschen Googeln soolte da schon weiterhelfen. Bei Seiten sind die Namen bitte immer in der Einzahl. Bei Kategorien sind die Namen immer in der Mehrzahl.

Kategorisierung

Fast alle Seiten sind kategorisiert. Oder besser gesagt, alle bis auf Spezialseiten. Darunter fällt die Hauptseite, die Themenseite und solche Sachen wie der Episodenguide. Alle anderen haben zumindest immer eine Kategorie, die ganz oben verewigt wird:

  • Seiten sind im Seitenindex
  • Kategorien im Kategoriendindex
  • Begriffe im Begriffsindex bzw. Glossar

Darüber hinaus, gucke wo deine Seite am besten hinpasst. Sollten es mehr als 3 Kategorien sein, also 4 mit dem Seitenindex kommen, die Kategorien bis auf den Seitenindex an den Schluss des Artikels.

Markierung

Es gibt Makierungen für zu überarbeitente Seiten und ähnliches. Wenn du diese verwendest oder entfernst, vermerke es bitte auf der Diskussionsseite.

Überarbeitung

Bevor du einen Artikel überarbeitest, besuche bitte zuerst die Diskussionsseite des Artikels damit du weißt, um was es geht.

Kommentarfunktion

Am Ende einer Bearbeitung gibt es die Möglichkeit, einen Kommentar zu verfassen. Nutze diese Möglichkeit, da es den Umgang untereinander erleichtert, wenn man mit einem Blick erkennt, was geändert wurde.

Artikel schreiben ist nicht so meins

Wenn du nicht gleich einen ganzen Artikel schreiben möchtest, gibt es bestimmt was anderes tolles was du kannst, z.B:

  • Übersetze doch vorhandene seiten Auf Englisch
  • Helfe mit deinem Wissen auf den Diskussionsseiten
  • Korrigiere Artikel auf Rechtschreibung
  • oder passe die Formatierung auf den Stylguide an

Wir können jede helfende Hand gebrauchen!

Regeln

Hier werden Dinge genannt, die man eigentlich nicht explitzit aufschreiben müsste, weil sie selbstverständlich sind. Aber damit wir alle auf Nummer sicher gehen können hier ein kleines Regelwerk:

Angebrachtes verhalten

Bitte verhalte dich gegenüber anderen immer korrekt. Ihr müsst keinen Kaffee zusammen trinken, aber Beleidigungen und Rassismus haben hier keinen Platz.

Wahrheit

Achte bitte durch deine Recherche darauf, dass die Dinge allgemein gültig sind. Es gibt vllt. Dinge, die einem persönlich nicht passen, dafür ist ein Wiki aber der falsche Platz. Hier sollte stehen, was "richtig" ist. Das heißt nicht, dass man keine Fehler machen darf, es gibt aber Leute die gerne Artikel auf ihr schräges Weltbild anpassen.

Urheberrecht

Es steht bereits unter dem Thema Quellen, aber es sei trotzdem erwähnt: Kopiere und verwende nichts, was du nicht verwenden darfst! Frage immer den Urheber wenn es nicht gekennzeichnet ist und achte bei Kennzeichnungen darauf was du damit machen darfst.

Der Ton macht die Musik

Bitte achte beim Schreiben auf deine Wortwahl. Sexsitisches, Gewaltverherrlichendes oder Schimpfwörter haben in einem Wikiartikel nichts verloren.

Allgemeiner Hinweis

Und zu guter Letzt ein allgemeiner Hinweis. Das Wiki ist Gemeinschaftsarbeit. Respektiere, was andere Schaffen und Schreiben, aber Rege dich nicht auf, wenn an deinen Texten herumgeschrieben wird. Wir schreiben für die Allgemeinheit. Sehe es doch als Bereicherung, wenn du der Keim einer wirklich gut geschriebenen Seite bist.