Wiki Als Dokumentations Tool
 
StartSeite | Neues | TestSeite | ForumSeite | Teilnehmer | Kategorien | Index | Hilfe | Einstellungen | Ändern

Von SoftwareDokumentation. Ausgangspunkt sind Fragen nach der Verwendbarkeit des Wiki für Dokumentationszwecke.

Ausgangpunkt

Eher Fragen, Anregungen oder FAQs:

--HardyGriech


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

Brauchbarkeit für Benutzerdokumentation

Etwa:

Schwierigkeit, die ich sehe:

-- GuntherWüsthoff

''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


Grundsätzliches

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


Stärken des Wiki in Bezug auf Dokumentation


Schwächen des Wiki in Bezug auf Dokumentation

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.


Anforderungen


Unter Umständen relevante Features

Vorhandene Features:

Features im Test: Geplante Features:
Antworten

...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.


...wie...strukturieren...

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.


...Druck der Dokumentation...

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).


KategorieDokumentation KategorieWiki
StartSeite | Neues | TestSeite | ForumSeite | Teilnehmer | Kategorien | Index | Hilfe | Einstellungen | Ändern
Text dieser Seite ändern (zuletzt geändert: 31. Juli 2010 18:16 (diff))
Suchbegriff: gesucht wird
im Titel
im Text