de:faq:documentation
Inhaltsverzeichnis
Warum eignet sich DokuWiki so gut für die Dokumentation?
Wikis eigenen sich gut für die Erstellung von Dokumentationen
- Einfach zu installieren
- Einfacher Einstieg: man kann unfertigen Inhalt veröffentlichen und famit vielen Menschen frühzeitig zugänglich machen
- Einfaches, einheitliches Seitenlayout
- Einfach zu erstellende und zu wartende Informationen, die strukturiert dargestellt werden:
- gemeinschaftliche Bearbeitung möglich
- einfach über den Webbrowser zu erreichen (mit oder ohne Benutzeranmeldung)
- einfach zu bearbeiten; keine HTML-Kenntnisse nötig
- einfach Erstellung von Querverweise
- Einheitliches Seitenlayout
- einfach zu bedienende Suchfunktion
- Externe Seiten können leicht eingebunden werden
- Keine Notwendigkeit einen Kollegen oder die IT-Abteilung um Aktualisierung der Dokumentation zu bitten, so dass die Dokumentation leicht aktuell gehalten werden kann.
DokuWiki ist sogar noch besser zur Dokumentation
- Einfache Bearbeitung:
- Bearbeiten einzelner Abschnitte einer Seite
- Leicht zu erlernende Syntax
- Automatische Dienste:
- Links zu nicht existierenden Artikeln werden rot dargestellt und können direkt genutzt werden, um die neue Seite anzulegen.
- Anzeige von sogenannten „backlinks“. Dadurch wird angezeigt, auf welchen anderen Seiten auf die aktuelle Seite verwiesen wird.
- automatische Indizierung der Seiten (ermöglicht Volltextsuche)
- Versionsverwaltung (Änderungen an einer Seite können angesehen und rückgängig gemacht werden)
- Anzeige eines Inhaltsverzeichnisses auf jeder Seite
- Unterstützt verschiedene Möglichkeiten Quelltexte einzubinden
- Verwaltung von Benutzern und deren Berechtigungen einfach zu administrieren
- Einfache aber mächtige Oberfläche zur Konfiguration der DokuWiki Kernfunktionen, des verwendetn Templates sowie der verwendeten Plugins
- Alle Seiten werden als Text-Datei gespeichert. Dadurch sind sie:
- lesbar, auch wenn die DokuWiki-Installation nicht mehr funktionsfähig ist
- einfach durch Skripte oder mittels FTP/sFTP zu sichern
- einfach zu lesen, zu bearbeiten, zu vergleichen und von externen Programmen (nicht-Wikis) zu erstellen / bearbeiten
- und können sehr einfach von einer DokuWiki-Installation zu einer anderen migriert werden
- Mit vielen Extras, die Dokumentation Spaß machen lassen: Fußnoten, Abkürzungen, Hervorhebungen im Quelltext
- Eine Vielzahl von verfügbaren Plugins für spezielle Anwendungsfälle
- Vielleicht mehr, das mir gerade nicht einfällt… :)
de/faq/documentation.txt · Zuletzt geändert: von andreash