Benutzer-Werkzeuge

Webseiten-Werkzeuge


wiki:beispiel_fuer_dokumentation

Dies ist eine alte Version des Dokuments!


Beispiel für Dokumentation

Auch für diese Seite gilt wie für alle Wiki-Seiten: Gerne ändern! Fällt jemandem ein zusätzlicher Tipp ein oder etwas auf, darf diese Seite gerne ergänzt werden.

Wie kann man möglichst gut eine Wiki-Seite erstellen, die etwas dokumentiert? Diese Seite soll ein paar Tipps und eine Struktur vorgeben. Wir nehmen dazu an, wir wollen dokumentieren, wie man eine Wiki-Seite anlegt.

1. Tipp: Durch Überschriften strukturieren. Überschriften zeigt das Wiki automatisch im Inhaltsverzeichnis an. Sinnvolle Überschriften für dieses Thema sind „Seiten anlegen“, „Seiten bearbeiten“, „Seiten löschen“.

Seiten anlegen

2. Tipp: Kapitel mit einer Einleitung beginnen. Dadurch wird klar, was in diesem Abschnitt passiert und wie es grundlegend erfolgt. Anschließend folgen die einzelnen Schritte.

Seiten werden am einfachsten angelegt, indem ein Link auf einer bestehenden Seite eingefügt wird und anschließend angeklickt wird.

  1. Eine bestehende Seite öffnen, von der aus auf die neue Seite verlinkt werden soll, z.B. der Spielplatz.
  2. Im Text einen neuen Link anlegen, indem folgendes geschrieben wird: [[Neue Seite]]
  3. Die Seite speichern. Der Link wird rot unterlegt dargestellt: Neue Seite
  4. Den Link anklicken, man erhält die Meldung, dass die Seite noch nicht existiert: Dieses Thema existiert noch nicht
  5. 3. Tipp: Ein Bild sagt mehr als 1000 Worte. Gerade im PC-Bereich gerne mit Screenshots ergänzen (unter Windows z.B. mit dem Snipping Tool).

    Das Symbol mit dem Stift und dem Plus anklicken (Mobil: „Werkzeuge“ → „Seite anlegen“) lässt einen die neue Seite bearbeiten.

  6. Ist sie gespeichert, wird der Link auf der alten Seite grün eingefärbt (Neue Seite), außerdem erscheint sie in der Seitenleiste.

Seite löschen

Wird eine Seite nicht mehr benötigt, kann sie gelöscht werden. Das sollte aber gut überdacht werden, da Seiten zu Archivierungszwecken am besten aufgehoben werden. Seiten sollten nur gelöscht werden, wenn sie doppelt oder aus Versehen angelegt wurden.

  1. Zum Löschen einer Seite die Seite bearbeiten und den gesamten Text löschen. Anschließend speichern.
  2. Nun die Links, die mal auf diese Seite gezeigt haben, ebenfalls entfernen oder ändern.
wiki/beispiel_fuer_dokumentation.1521975628.txt.gz · Zuletzt geändert: 2022/08/14 20:05 (Externe Bearbeitung)

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki