Änderungen von "Dokumentation/WikiNutzung"

Unterschiede zwischen den Revisionen 1 und 19 (über 18 Versionen hinweg)

Wiki-Nutzung

Inhaltsverzeichnis

Wiki-Nutzung

Das ITZkS-Wiki soll für jedermann schnell nachvollziehbar die wichtigen Informationen bereitstellen, die für die Administration der ITZKS-Schulinfrastruktur benötigt werden. Dazu ist es wichtig, dass die Inhaltserstellung nach festen Konventionen erfolgt. Im folgenden Abschnitt werden diese Konvetionen erläutert.

Neue Seiten anlegen

Im ITZKS-Wiki gibt es verschiedene Möglichkeiten neue Seiten anzulegen. In diesem Wiki werden keine CamelCase (SeiteUnterseite) Seitenstrukturen verwendet, sondern ausschliesslich Unterseiten ähnlich Namespaces (Seite/Unterseite) angelegt. Der einfachste Fall Unterseiten neu anzulegen ist, einen Link auf die neue Seite auf einer bestehenden Seite anzulegen. Die Konvention für interne Links:

[[Oberseite/Unterseite1/UnterUnterseite1|sprechender Linktext für Unterunterseite 1]

Nach Erstellung des Links und speichern der Änderungen, klickt man auf den Link und wählt im Folgefenster "Seite anlegen". Im dann erscheinenden Editorfenster den Seitentitel folgenderweise eintragen:

== Seitentitel Unterunterseite 1 ==

Textgliederung

Eine Dokumentation soll ermöglichen schnell die gebrauchte Information zu finden. Deshalb ist es sinnvoll Textblöcke in inhaltliche Einheiten zu zerlegen und durch Zwischenüberschriften zu beschreiben. In diesem Wiki (MoinMoin) stehen fünf Überschriftenbenen zur Verfügung (http://www.wikiwikiweb.de/HilfeZurMoinWikiSyntax#A.2BANw-berschriften).

Überschriften in diesem Wiki

Die fünfte Überschriftenebene ist jedoch kleiner als fett geschrieber Text. Sie ist somit nicht eindeutig als Gliederung zu erkennen. Daher verwenden wir nur Überschriftenebene 1-4

Listen

Für das Arbeiten mit Anleitungen hat sich gezeigt, dass man Listen mit bis zu 7 Unterpunkten gut abarbeiten kann. Längere Listen sind nicht so übersichtlich und erschweren damit das Auffinden der gesuchten Information. Wenn eine Liste von Arbeitsschritten mehr als 7 Unterpunkte aufweißt sollten Zwischenüberschriften eingefügt werden, die das Finden der Informationen erleichtern. Das gilt natürlich nicht sträflich. Wenn eine Liste nach 8 oder 9 Punkten abschlossen ist, muss man nicht extra für die 2 Punkte eine Zwischenüberschrift einfügen.

Fehler korrigieren / Verbesserungen einarbeiten

Oftmals ist es nicht möglich, Fehler oder Ungenauigkeiten im Wiki sofort zu beheben. Mal mangelt es an Zeit und Fokus, mal auch an Kenntnissen.

Dennoch sollten wir Passagen im Wiki, die eine Überarbeitung benötigen, immer sofort beim Auffinden des Mangels markieren. Später können wir die markierte Stelle dann entweder selbst überarbeiten bzw. von jemand anderem im Projekt überarbeiten lassen.

Fehler bzw. verbesserungsfähige Passage im Wiki finden
Passage mit dem Ausdruck FixMe markieren und ggf. einen kurzen Kommentar anfügen, warum wir denken, dass die Stelle überarbeitet werden muss
Später dann: FixMe-Markierungen im Wiki aufspüren über diese Seite: FixMe
Markierten Abschnitt bearbeiten und verbessern

IT-Zukunft Schule: Dokumentation/WikiNutzung (zuletzt geändert am 2012-02-20 10:12:02 durch MarcelSandow)

-  ⇤ ← Revision 1 vom 2012-02-16 10:20:40 → 
  Größe: 1112
  Autor: MarcelSandow
  Kommentar:
+   ← Revision 19 vom 2012-02-20 10:12:02 → ⇥
  Größe: 3197
  Autor: MarcelSandow
  Kommentar:
-Gelöschter Text ist auf diese Art markiert.
+Hinzugefügter Text ist auf diese Art markiert.
 Zeile 1:
-== Wiki Nutzung ==
+== Wiki-Nutzung ==
 Zeile 3:
-Das ITZKS-Wiki soll für jedermann schnell nachvollziehbar die wichtigen Informationen bereitstellen, die für die Administration der ITZKS-Schulinfrastruktur benötigt werden. Dazu ist es wichtig, dass die Inhaltserstellung nach festen Konventionen erfolgt. Im folgenden Abschnitt werden diese Konvetionen erläutert.
+<<TableOfContents(3)>>

Das ITZkS-Wiki soll für jedermann schnell nachvollziehbar die wichtigen Informationen bereitstellen, die für die Administration der ITZKS-Schulinfrastruktur benötigt werden. Dazu ist es wichtig, dass die Inhaltserstellung nach festen Konventionen erfolgt. Im folgenden Abschnitt werden diese Konvetionen erläutert.
-Zeile 7:
+Zeile 9:
-Im ITZKS-Wiki gibt es verschiedene Möglichkeiten neue Seiten anzulegen. In diesem Wiki werden keine CamelCase (SeiteUnterseite) Seitenstrukturen verwendet, sondern ausschliesslich Unterseiten ähnlich Namespaces (Seite/Unterseite) angelegt.
+Im ITZKS-Wiki gibt es verschiedene Möglichkeiten neue Seiten anzulegen. In diesem Wiki werden keine {{{CamelCase}}} ({{{SeiteUnterseite}}}) Seitenstrukturen verwendet, sondern ausschliesslich Unterseiten ähnlich Namespaces ({{{Seite/Unterseite}}}) angelegt.
-Zeile 10:
+Zeile 12:
+{{{
-Zeile 11:
+Zeile 14:
+}}}
-Zeile 12:
+Zeile 16:
-Nach Erstellung des Links und speichern der Änderungen, klickt man auf den Link und wählt im Folgefenster "xyz Seite anlegen". Im dann erscheinenden Editorfenster den Seitentitel folgenderweise eintragen:
+Nach Erstellung des Links und speichern der Änderungen, klickt man auf den Link und wählt im Folgefenster "Seite anlegen". Im dann erscheinenden Editorfenster den Seitentitel folgenderweise eintragen:
-Zeile 14:
+Zeile 18:
-== Seitentitel == to do !
+{{{
== Seitentitel Unterunterseite 1 ==
}}}

=== Textgliederung ===

Eine Dokumentation soll ermöglichen schnell die gebrauchte Information zu finden. Deshalb ist es sinnvoll Textblöcke in inhaltliche Einheiten zu zerlegen und durch Zwischenüberschriften zu beschreiben. In diesem Wiki (MoinMoin) stehen fünf Überschriftenbenen zur Verfügung (http://www.wikiwikiweb.de/HilfeZurMoinWikiSyntax#A.2BANw-berschriften). 

==== Überschriften in diesem Wiki ====
Die fünfte Überschriftenebene ist jedoch kleiner als fett geschrieber Text. Sie ist somit nicht eindeutig als Gliederung zu erkennen. 
Daher verwenden wir nur Überschriftenebene 1-4
 
==== Listen ====

Für das Arbeiten mit Anleitungen hat sich gezeigt, dass man Listen mit bis zu 7 Unterpunkten gut abarbeiten kann. Längere Listen sind nicht so übersichtlich und erschweren damit das Auffinden der gesuchten Information. Wenn eine Liste von Arbeitsschritten mehr als 7 Unterpunkte aufweißt sollten Zwischenüberschriften eingefügt werden, die das Finden der Informationen erleichtern. Das gilt natürlich nicht sträflich. Wenn eine Liste nach 8 oder 9 Punkten abschlossen ist, muss man nicht extra für die 2 Punkte eine Zwischenüberschrift einfügen.
-Zeile 17:
+Zeile 35:
+=== Fehler korrigieren / Verbesserungen einarbeiten ===
-Zeile 18:
+Zeile 37:
+Oftmals ist es nicht möglich, Fehler oder Ungenauigkeiten im Wiki ''sofort'' zu beheben. Mal mangelt es an Zeit und Fokus, mal auch an Kenntnissen.

Dennoch sollten wir Passagen im Wiki, die eine Überarbeitung benötigen, immer sofort beim Auffinden des Mangels markieren. Später können wir die markierte Stelle dann entweder selbst überarbeiten bzw. von jemand anderem im Projekt überarbeiten lassen.

 1. Fehler bzw. verbesserungsfähige Passage im Wiki finden
 1. Passage mit dem Ausdruck {{{FixMe}}} markieren und ggf. einen kurzen Kommentar anfügen, warum wir denken, dass die Stelle überarbeitet werden muss
 1. Später dann: {{{FixMe}}}-Markierungen im Wiki aufspüren über diese Seite: FixMe
 1. Markierten Abschnitt bearbeiten und verbessern