Guidelines

Im Folgenden werden Guidelines definiert, die bei der Mitarbeit auf diesem Wiki zu beachten sind. Als Grundlage dienen die Guidelines von Wikipedia, die für dieses Wiki wie folgt erweitert werden:

• Neutralität: Eigene Meinungen sind zu vermeiden.
• Quellenangabe: Sofern fremde Inhalte genutzt werden, sind diese zu zitieren und die Quelle zu referenzieren. Es dürfen keine Urheberrechte verletzt werden.
• Anonymität: Beispiele dürfen keine Inhalte dritter enthalten. So müssen IP-Adressen, Domains, E-Mail-Adressen e.t.c. unbedingt anonymisiert werden.
• Ein Artikel sollte ein möglichst hohes Maß an Vollständigkeit bezüglich des beschriebenen Themas aufweisen. Unvollständige Artikel sind an geeigneter Stelle mit (Syntax: FIXME) zu kennzeichnen.
• Die Sprache des Wikis ist Deutsch.

Der Inhalt des Wikis umfasst

• Technische Artikel in den Themenbereichen Client/Server
• Themen der Wirtschaftsinformatik

• Vor dem Erstellen eines Artikels sollte geprüft werden, ob der gleiche oder ein ähnlicher Artikel bereits existiert.
• Nicht erläuterte Fachbegriffe, die essentiell für das Verständnis des Artikels sind, sollten zu weiterführenden internen Artikeln oder zu einer Enzyklopädie, wie z.B. Wikipedia, verlinkt werden.

Eine vollständige Beschreibung der Syntax findet sich unter https://www.dokuwiki.org/wiki:syntax. Die im Folgenden gelisteten Bereiche sollte primär wie hier beschrieben syntaktisch umgesetzt werden.

In der Syntax ist nach einer Überschrift eine Leerzeile einzufügen und zwei Leerzeilen vor der nächsten Überschrift. Dies erleichtert die Lesbarkeit des Codes.

Umfasst der Code nur eine oder wenige Zeilen oder für den Fall, dass Syntax-Highlighting die Lesbarkeit nicht unbedingt erleichtert, kann zum Einbinden des Codes zwei hintereinanderfolgende Leerzeichen genutzt werden.

Diesem Text gehen zwei Leerzeichen zuvor.

Beim Einfügen von Code aus Programmiersprachen, Pfade zu Dateiverzeichnissen u.ä. sollte das automatische Syntax-Highlighting verwendet werden:

<code VERWENDETE PROGRAMMIERSPRACHE> 
  ... der Quellcode ... 
</code>

Eine Liste der derzeit unterstützten Programmiersprachen findet sich unter https://www.dokuwiki.org/wiki:syntax#syntax_highlighting.

Aufrufe in der Befehlszeile, die root-Rechte benötigen, sind mit einer Raute zu kennzeichnen:

# passwd

Links sollen so häufig wie möglich und sinnvoll wie nötig verwendet werden.

[[URL|Beschreibung oder Text im Fließtext]]

Fußnoten sind in kurzen Artikeln zu vermeiden, weil sie nicht direkt zum Ziel des Links führen, sondern zuvor an das Ende des Artikels springen. Dort ist dann eine Liste aller im Artikel verwendeten Links zu finden. Somit werden Fußnoten erst bei sehr umfangreichen Artikeln sinnvoll, da z.B. hier doppelt verwendete Links einfach identifiziert werden können.

Links zu anderen Wikis (z.B. Wikipedia, wiki.ubuntuusers.de) oder auch anderen wichtigen Seiten können durch Inter-Wiki-Links erstellt werden, z.B:

[[wpde>Deutschland]]

[[google>Wiba10]]

[[uu>apt]]

erzeugt folgende Ausgabe:

Deutschland

Wiba10

apt

Alle Artikel sind in der letzten Zeile des Codes wie folgt zu taggen:

{{tag>tag1 tag2 tag3}}

Für das Taggen gelten folgende Konventionen:

• Jeder Artikel hat ein bis beliebig viele Tags. Die Anzahl der Tags ist themenabhängig, es sollte jedoch mehr als ein Tag benutzt werden.
• Tags treten nur im Singular auf.
• Themennahe Artikel sollten ähnliche Tags aufweisen.