Eher Fragen, Anregungen oder FAQs:

• wie wäre es Wiki als Dokumentationstool zu verwenden?
• wie könnte man die Dokumentation dann strukturieren?
• welche Features fehlen?
• Druck der Dokumentation,
• welche Links sind noch nicht aufgefüllt?,
• :

Dies ist der Grund, warum ich mich für Wiki interessiere:

Brauchbarkeit für Benutzerdokumentation

Etwa:

• Wiki als projektbegleitendes Kommunikations- und Interaktionswerkzeug.
• Als Dokumentationswerkzeug für diese Kommunikation und Interaktion.
• Filterung und Übersetzung in BenutzerSprache?.
• Ergänzung bis zur Vollständigkeit und Verständlichkeit.
• Begrenzung auf die BenutzerSicht (Ausblenden der Projektinterna).
• Strukturelle Bearbeitung (Inhalt, Index)

• Wiki ist ein Netzwerk, alle Seiten sind 'von Natur aus' gleichberechtigt.
• Diese Tatsache erschwert dem Benutzer den direkten Zugriff auf benötigte Information. (Metaphern: Inhaltsverzeichnis, Index)
• Er muss umdenken in Richtung Suchmaschine.
• Linearisierung in Bezug auf Drucken: LoseBlattSammlung oder aufgesetzte Hierarchisierung?

''Ich denke eine Hierarchisierung wäre die bessere Lösung. Ein zusätzlicher Parameter in einer Überschrift könnte aus der nachfolgenden Liste von Links eine hierarchische Information machen, die zur Zusammenstellung eines Gesamtdokuments verwendet wird. Diese könnte entweder wieder als HTML-Seite (analog zur TWiki-BookView?-Funktion) oder als ASCII-TEXT zur Weiterverarbeitung Richtung WORD-Dokument (oder RTF) verwendet werden. -- HelmutLeitner

In dem TWiki gibt es eine quasi automatische Hierarchisierungs-Technik: Fügt man einen neuen Wiki-internen Link auf einer Wiki-Seite ein (wird dann wie üblich mit einem Fragezeichen garniert), so wird die enthaltende Seite automatisch zur Parent-Seite der neuen Seite, und auf jeder Seite erscheint unten eine Reihe von Links auf die entsprechenden übergeordneten Seiten. Die Parent-Seite kann aber auch explizit gesetzt/geändert werden. Wünschenswert wäre aber dann natürlich auch eine Möglichkeit, die jeweils untergeordneten Seiten aufzufinden. (Vgl. auch Typo3: Ein browser-basiertes ContentManagementSystem mit automatischer Hierarchisierung.) -- KlausGünther

Es gehört zum Wesen des Wiki, dass es in Kontakt mit den Benutzern und mit den Anforderungen schrittweise wächst. Dahinter steckt - kurz gesagt - die Philosophie lebendiger Systeme (ChristopherAlexander) bzw. die Gedankenwelt von ExtremeProgramming.

Wenn jemand den Versuch machen möchte, ein Wiki für eine reale Dokumentation einzusetzen, und gemeinsam alle dabei auftauchenden Probleme zu bearbeiten, würde ich die Infrastruktur und die technische Unterstützung beisteuern.

-- HelmutLeitner

• Das Wiki ist vor allem auch ein Publikationstool. Alles was geschrieben wird kann sofort gelesen und damit genutzt werden. In der offenen Form (siehe SupportWiki:StartSeite) kann jeder Benutzer auch schreiben. In der geschlossenen Form (siehe WikiWeb:HerzlichWillkommen) kann nur ein angemeldeter Benutzer Änderungen vornehmen.
• Im Wiki kann eine Dokumentation ohne zusätzlichen Aufwand im Team erstellt und gewartet werden.
• Im Wiki kann eine Dokumentation in Kontakt mit dem Anwender gepflegt und erweitert werden.
• Man kann statistische Informationen über die Nutzung sammeln, so dass man die Dokumentation gezielt dort verbessert, wo tatsächlicher Bedarf besteht. Im Prinzip ist das die Funktion TopFünfzig, die mit Parametern beliebig adjustiert werden kann.
• Im Wiki kann die Dokumentation in einem reichhaltigem Umfeld von zusätzlichen Resourcen, teilweise auch von wiederverwendbaren Dokumentations-Bausteinen entstehen.
• ...

• Es gibt derzeit keine Konvertierungstools in Richtung WORD, PDF, HLP, RTF etc.
• Wiki ist keine SpracheXml

Das sehe ich nicht als Schwäche, denn Wiki ist als Tool für Endbenutzer gedacht, XML dafür ungeeignet. Somit schließt sich beides ohnehin aus. Denkbar ist jedoch eine automatische Konvertierung.

• ...

Vorhandene Features:

• bestimmte Konfigurationsoptionen
• halboffene oder geschlossene Wiki-Varianten durch Einschränkung von Leserecht und Änderungsrecht.
• Unterseiten ("subpages") erlauben eine zusätzliche Strukturierung.
• ...
• bestimmte Funktionen für berechtige Benutzer
• Das Ändern von Seiteneigenschaften (z.B. der HTML-Vorlage)
• Funktionen, die sich auf mehrere Wikis beziehen (z.B. "global recent changes")
• ...

• Eine Rechtschreibkontrolle mit Wartung der verwendeten Wörterbücher. Siehe FreeDictWiki:SpracheLojban. Siehe Link "RSK" am Fuß jeder Seite, bzw. die Zusatzfunktion "Wörterbuch" am Fuß der Seite "Einstellungen".
• Für Korrekturarbeiten könnte die Streichung von Textteilen eventuell eine Hilfe sein. Die Streichung kann auch mit der Marker-Funktion zur Streichung und Einfärbung von Textteilen verwendet werden. Testweise eingeführt am 9.10.2001 10.7.2001.
• ...

• Die Nutzung von Standardwortschätzen und Erweiterungswortschätzen zur automatischen Aufbereitung fremdsprachiger Texte im E-Learning-Bereich. Z.B. automatisches Markieren aller "schwierigen" Worte und automatisches Hinterlegen der Erklärung. Diese Funktionalität könnte leicht zur Kontrolle eines Standardwortschatzes (NormierteSprache) verwendet werden.
• ...

...wie wäre...als Dokumentationstool...

Meines Wissens ist das ein relativ häufiger Anwendungsfall, besonders für die Projektdokumentation. Aber auch in der Softwaredokumentation sollte es sich gut bewähren.

• Realisierung Linux-Doku: LinuxWiki. Die 1000-Seiten-Marke ist seit einiger Zeit überschritten.

Das hängt wahrscheinlich davon ab, ob man z.B. ein Softwareprodukt in einem einzigen WikiWeb dokumentiert, oder ob man mehrere Produkte (oder Produktversionen) in einem WikiWeb dokumentieren möchte.

Es gibt eine Reihe von existierenden, im Test befindlichen oder geplanten Wiki-Funktionen die in einem Dokumentationsprojekt wichtig sein könnten. Das reicht von Subseiten bis zu Funktionen, die über mehrere Wikis hinweg wirken.

Da fehlt sicher eine Funktion, die einerseits ein vereinfachtes Seitenlayout anwendet. Das ist eine Anregung, die von einem Benutzer auch schon für das ballastfreie Drucken einzelner Seiten vorgeschlagen wurde. Technisch ist das kein Problem.

Zusätzlich braucht man eine Möglichkeit die hierarchischen Struktur des Dokumentation zu definieren. Dazu würde schon eine spezielle Überschrift mit nachfolgender Gliederung genügen.

Frage:

Gibt es Erfahrungen, ein Wiki als Tool zu benutzen, um mit den Usern zusammen eine Hilfe für eine Applikation zu erstellen ? --ToKa

Antwort:

Man müsste die Erfahrungsberichte englischer WikiWebs absuchen (z.B. TWiki:Main/TWikiSuccessStories) und eventuell mit den Betreuern dieser Wikis Kontakt suchen, ob so etwas schon gemacht wurde. In deutschen Wikis ist mir bisher nichts bekannt (Juli 2001).