12. Feb 2024
Lesedauer 13 Min.
Erweiterbares Wissen
Open-Source-Wiki
Die Software Wiki.js passt sich je nach Bedarf an die unterschiedlichsten Projekte gut an.
dotnetpro
Wikis haben sich als weit verbreitete Methode etabliert, um Wissen zu speichern und zugänglich zu machen (Bild 1). Sie ermöglichen es, eine dynamische Wissensbasis aufzubauen, die von den Nutzern selbst ständig erweitert und aktualisiert werden kann. In Unternehmen und Organisationen etwa kommen unterschiedliche Softwareprodukte zum Einsatz, um Wikis effektiv zu nutzen und den Wissensaustausch zu fördern.
Sinnbild für Wikis schlechthin: Wikipedia (Bild 1)
Autor
Beispielsweise sind Wikis ein beliebtes Werkzeug bei Softwareteams und -projekten, da sie die Zusammenarbeit und den Wissensaustausch innerhalb der Gruppe fördern. Sie bieten eine zentrale Plattform, auf der Informationen zu Konzepten, Code, Dokumentationen und Best Practices gesammelt und gemeinsam bearbeitet werden können. Durch den Einsatz von Wikis können Teams effizienter arbeiten, da sie schnell auf benötigte Informationen zugreifen und diese bei Bedarf direkt aktualisieren können.Insbesondere in agilen Entwicklungsprozessen sind Wikis ein wertvolles Hilfsmittel, um die Kommunikation und Transparenz innerhalb des Teams zu verbessern.Ein Beispiel für eine moderne und leistungsstarke Open-Source-Software für Wikis ist Wiki.js [1]. Der Fokus dieses Artikels liegt auf Wiki.js als Projektsoftware und darauf, wie es sich von anderen Wiki-Systemen unterscheidet. Dabei geht es um die Vorteile ebenso wie um Merkmale, Installation und Anwendungsfälle.
Herausforderungen auf mehreren Ebenen
Die erfolgreiche Einführung eines Wikis und das effiziente Wissensmanagement in Unternehmen erfordern eine sorgfältige Planung und Umsetzung (siehe auch den Kasten Wissensmanagement). Dabei sind beim Wissensmanagement eine Reihe von Herausforderungen zu lösen, aber auch bei der konkreten Einführung eines Wikis. Zudem spielen sowohl technische als auch organisatorische und kulturelle Aspekte eine wichtige Rolle, wenn es um das Erstellen, Teilen und Bearbeiten von Wissen geht.Wissensmanagement
Wissensmanagement ist der Prozess, innerhalb einer Organisation Informationen zu identifizieren, zu organisieren, zu speichern und zu verbreiten. Es umfasst den Umgang mit explizitem und implizitem Wissen, wobei explizites Wissen leicht zugänglich und dokumentiert ist, während implizites Wissen auf den Erfahrungen und dem Können der Mitarbeiter basiert.
Das Wissensmanagement stellt Unternehmen in einer Zeit, in der das Wissen rasant zunimmt und gleichzeitig fragmentiert, vor Herausforderungen. Das bedeutet, dass Unternehmen mit der schnell wachsenden Menge an Wissen und Informationen, die in verschiedenen Abteilungen erzeugt werden, umgehen können müssen. Hier spielen auch die Aktualität und die Relevanz von Informationen eine Rolle. Ein gutes Wissensmanagement auf Grundlage veralteter Daten wird schlussendlich keinen positiven Beitrag im Unternehmen leisten können.Darüber hinaus sind Unternehmen mit immer kürzeren Entwicklungszeiten und höheren Qualitätsanforderungen konfrontiert, sodass sie unter Druck stehen, schneller und kreativer zu sein und gleichzeitig die Qualität ihrer Produkte und Dienstleistungen zu erhöhen. Das erfordert ein rigoroses und effizientes WissensmanagementAuf der Seite der Nutzer spielen der Umgang mit Wikis (Usability) wie auch die Akzeptanz an sich wichtige Rollen. Mitarbeitende müssen die Tools für das Wissensmanagement akzeptieren und einsetzen, um den größtmöglichen Nutzen daraus zu ziehen. Werkzeuge, die sich schlecht bedienen lassen oder die wegen fehlender Akzeptanz gar nicht verwendet werden, können keinen Beitrag zum Wissensmanagement leisten.Die Herausforderungen bei der Einführung eines Wikis in einem Projekt lassen sich wie folgt zusammenfassen:Auswahl der richtigen Wiki-Software: Die Auswahl der passenden Wiki-Software ist entscheidend für den Erfolg des Projekts und sollte auf den spezifischen Anforderungen des Unternehmens basieren. Nicht alle Projekte müssen unterschiedliche Arten von Editoren oder Anzeigemöglichkeiten haben, um zwei Beispiele zu nennen.Auswahl der richtigen Wiki-Software:Technische und organisatorische Aufgaben: Die Einführung eines Wikis erfordert sowohl technische als auch organisatorische Anpassungen, um eine reibungslose Einbindung in die bestehenden Prozesse zu gewährleisten. War vor der Einführung kein Wiki vorhanden, kann es sein, dass zunächst der Fokus auf Wissensmanagement an sich liegen muss.Technische und organisatorische Aufgaben:Mitarbeitermotivation: Die Mitarbeiter müssen motiviert und geschult werden, um aktiv am Wiki teilzunehmen und es regelmäßig zu nutzen.Mitarbeitermotivation:Strukturierung des Wikis: Die Organisation und Strukturierung der Inhalte im Wiki sind entscheidend für die Nutzerfreundlichkeit und Akzeptanz des gesamten Systems und des Wissensmanagements.Strukturierung des Wikis:Rechtliche Aspekte: Unternehmen müssen sich auch mit rechtlichen Fragen wie der Lizenzierung von Inhalten, der Haftung für rechtswidrige Inhalte und dem Datenschutz auseinandersetzen.Rechtliche Aspekte:
Was ist Wiki.js?
Wiki.js ist eine moderne und leistungsstarke Open-Source-Wiki-Software, die auf Node.js, Git und Markdown aufbaut – siehe auch den Kasten Was ist ein Wiki?. Sie lässt sich anpassen und ist modular aufgebaut, sodass sie sich auf unterschiedliche Anforderungen und Umgebungen zuschneiden lässt. Zudem zeichnet sich Wiki.js durch eine moderne Nutzeroberfläche und fortschrittliche Funktionen aus. Die Anwendung ist kompatibel mit verschiedenen Datenbanken wie PostgreSQL, MySQL, MariaDB, MS SQL Server und SQLite. Dadurch kann Wiki.js auf nahezu jeder gängigen Plattform installiert und betrieben werden. Die Installation ist schnell und einfach und es gibt Schritt-für-Schritt-Anleitungen für verschiedene Plattformen.Was ist ein Wiki?
Ein Wiki ist eine webbasierte Plattform, die es Nutzern ermöglicht, Inhalte gemeinsam zu erstellen, zu bearbeiten und zu organisieren. Der Begriff „Wiki“ stammt aus dem Hawaiianischen und bedeutet „schnell“. Wikis sind netzartig aufgebaut und die einzelnen Inhalte (Seiten) sind durch Verknüpfungen (Hyperlinks) miteinander verbunden.
Die aktuelle stabile Version ist 2.5.300. Der Quelltext des Projekts ist auf GitHub verfügbar und steht unter der AGPL-3.0-Lizenz [2].
Anforderungen an ein Wiki
Aus der Perspektive eines Unternehmens mit unterschiedlichen Abteilungen sollten Wikis bestimmte Anforderungen erfüllen, um effizient für das Wissensmanagement und die Zusammenarbeit eingesetzt werden zu können. Dazu gehören Klassiker wie eine hohe Nutzerfreundlichkeit und ein im besten Fall nahezu wartungsfreier Betrieb.Dazu gesellen sich Anforderungen wie eine hohe Flexibilität, um die Anwendung an spezifische Anforderungen und Prozesse anzupassen. Ein effektives Wiki-System sollte zudem die Verwendung von Zugriffsrechten und Sicherheitsmechanismen bieten, um sensible Informationen zu schützen und Datenschutzrichtlinien einzuhalten.Neben einer Strukturierung und Organisation von Inhalten, um die Auffindbarkeit und Übersichtlichkeit der Informationen zu gewährleisten, sind eine Versionskontrolle und Nachverfolgbarkeit essenziell. Ein Wiki sollte Änderungen an Inhalten nachverfolgbar machen und die Möglichkeit bieten, ältere Versionen wiederherzustellen, um Transparenz und Verantwortlichkeit zu gewährleisten. Ein weiterer, wichtiger Aspekt ist eine leistungsfähige und effektive Suchfunktion. Diese ist entscheidend, um Informationen schnell und einfach im Wiki auffinden zu können. All das gilt für und bietet auch Wiki.js.Andere Punkte, wie die Integration in bestehende Systeme, die Skalierbarkeit und ein guter Support sowie eine Weiterentwicklung, hängen stark vom Einsatz des Wikis in einem Projekt oder Unternehmen ab.Insgesamt können Wikis dazu beitragen, das Wissensmanagement in Unternehmen effektiver und effizienter zu gestalten, indem sie den Zugang zu und die Nutzung von Wissen erleichtern.Funktionalitäten und Features
Wiki.js bietet eine Vielzahl von Funktionen und Merkmalen, die es zu einer modernen und leistungsstarken Wiki-Software machen. Zu den wichtigsten gehören:- Es bietet verschiedene Editoren für unterschiedliche Nutzerpräferenzen und Inhaltsarten.
- Nutzeroberfläche und Funktionsumfang lassen sich bei Bedarf anpassen.
- Die Software lässt sich durch Module erweitern, die man auch selbst implementieren kann.
- Das System bietet ein umfangreiches Rechtemodell mit öffentlichen, privaten oder gemischten Zugriffsstufen.
- Eine leistungsstarke Suchfunktion ist vorhanden.
- Es gibt unterschiedliche Möglichkeiten der Darstellung.
- Historie und Lokalisierung sind enthalten.
Tabelle 1: Mögliche Formatkonvertierungen und wie sie funktionieren
|
Wiki.js ist, wie schon erwähnt, vollständig anpassbar und modular aufgebaut, sodass es auf unterschiedliche Anforderungen und Umgebungen zugeschnitten werden kann. Das bedeutet, dass sich zum Beispiel die Nutzeroberfläche anpassen lässt, einschließlich eines hellen und dunklen Modus. Die Erweiterbarkeit wird durch Module erreicht, welche die Funktionalität von Wiki.js erweitern und verändern.Das System bietet eine Suchfunktion, die sowohl in den Titeln als auch in den Inhalten der Seiten sucht. Die Ergebnisse können Bilder und Inhaltsbeschreibungen enthalten, um die Auffindbarkeit und Übersichtlichkeit der Informationen zu verbessern. Diese eingebaute Suchmaschine ist ohne weitere Installation oder Konfiguration einsetzbar und basiert auf den Daten in der Wiki.js-Datenbank. Zudem gibt es die Möglichkeit, eine Cloud-Suche einzubinden, wie Algolia [4] oder Azure Search [5]. Diese Dienste erweitern die Suchmöglichkeiten enorm.
Installation und Einrichtung
Wiki.js ist für seine schnelle und einfache Installation bekannt, die es den Nutzern ermöglicht, in kürzester Zeit ein funktionsfähiges Wiki-System aufzusetzen. Die Installation von Wiki.js ist unkompliziert und erfordert nur wenige Schritte, um das System auf verschiedenen Plattformen und Umgebungen einzurichten. Dabei ist die Unterstützung für die einzelnen Plattformen und Installationsmethoden sehr gut entwickelt. Von der schnellen lokalen Installation über Docker für Windows bis hin zum Deployment in der Cloud ist alles denkbar.Die Wiki.js-Software ist kompatibel mit einer Vielzahl von Datenbanken, darunter PostgreSQL, MySQL, MariaDB, MS SQL Server und SQLite. Diese Kompatibilität ermöglicht es Anwendern, Wiki.js in ihrer bevorzugten Umgebung und mit der Datenbank ihrer Wahl zu betreiben.Für die Installation von Wiki.js auf Windows über Docker ist zunächst Docker zu installieren. Anschließend wird ein Verzeichnis für die Wiki.js-Installation erzeugt; darin wird die Datei docker-compose.yml abgelegt. Ein Beispiel dazu ist in Listing 1 zu sehen; es nutzt eine PostgreSQL-Datenbank.Listing 1: Beispiel für die Datei docker-compose.yml
version: "3" <br/>services: <br/> <br/> db: <br/> image: postgres:15-alpine <br/> environment: <br/> POSTGRES_DB: wiki <br/> POSTGRES_PASSWORD: wikijsrocks <br/> POSTGRES_USER: wikijs <br/> logging: <br/> driver: "none" <br/> restart: unless-stopped <br/> volumes: <br/> - db-data:/var/lib/postgresql/data <br/> <br/> wiki: <br/> image: ghcr.io/requarks/wiki:2 <br/> depends_on: <br/> - db <br/> environment: <br/> DB_TYPE: postgres <br/> DB_HOST: db <br/> DB_PORT: 5432 <br/> DB_USER: ... <br/> DB_PASS: ... <br/> DB_NAME: ... <br/> restart: unless-stopped <br/> ports: <br/> - "80:3000" <br/> <br/>volumes: <br/> db-data:
Wenn die Datei platziert ist, lässt sich der folgende Befehl ausführen, um die Wiki.js-Installation mit Docker abzuschließen und den Container zu starten:
docker compose up -d
Läuft der Container, können Sie einen Webbrowser öffnen und zum angegebenen URL navigieren, um den Wiki.js-Setup-Assistenten zu starten. Hat dieser seine Arbeit beendet, ist die Installation abgeschlossen.Nach Abschluss der Installation ist die Software für das Wissensmanagement und die Zusammenarbeit im Unternehmen bereit.
Module von Wiki.js
Wie bereits beschrieben ist Wiki.js modular aufgebaut und bietet verschiedene Module in unterschiedlichen Kategorien. Die Module sind dafür gedacht, die Funktionalität der Software zu erweitern und an spezifische Anforderungen anzupassen. Einige der Hauptkategorien für Module sind:- Analyse: Module, um Sitzungsverfolgungen zu analysieren und die Überwachung der Browserleistung im Wiki schnell zu aktivieren.
- Authentifizierung: Module, die verschiedene Authentifizierungsmethoden unterstützen, wie OAuth2, LDAP oder SAML.
- Speicherung: Diese Module speichern Inhalte und Dateien in verschiedenen Speichersystemen wie lokalen Dateisystemen, Amazon S3 oder Google Cloud Storage.
- Suche: Module, die verschiedene Suchmaschinen einbinden, um die Suche in Wiki.js zu verbessern.
- Renderer: Module, die verschiedene Renderer für die Darstellung von Inhalten unterstützen, wie Markdown, HTML oder LaTeX.
Wiki.js aus Entwicklersicht
Alle Module sind unter server/modules angeordnet. Für jede Modulkategorie gibt es Anleitungen, die beschreiben, wie sich eigene Module implementieren lassen.Dennoch gibt es Gemeinsamkeiten, da alle Module die gleiche Grundstruktur haben. Sie bestehen aus einer Definitionsdatei mit Namen definition.yml, die Informationen und die Konfiguration eines Moduls enthält, und einer Codedatei, in der sich die eigentliche Logik befindet. Module sind völlig eigenständig und laufen nicht im gleichen Kontext wie die Wiki.js-Kernanwendung – es sei denn, dies ist in der Dokumentation ausdrücklich angegeben.Das bedeutet auch, dass alle Abhängigkeiten, die nicht schon in Wiki.js enthalten sind, im Modulverzeichnis liegen müssen. Diese Abhängigkeiten werden mit einem Paketmanager wie NPM verwaltet und in der Datei package.json abgelegt.Ein Beispiel für eine Definitionsdatei ist in Listing 2 zu sehen. Der Code für die Kommentarfunktion wird in der Datei mit dem Namen code.yml des Moduls hinterlegt (Listing 3). Sie enthält die Codeschnipsel, die in die Head-, Body- und Comment-Abschnitte einzufügen sind. Die Implementierung der Kommentarfunktionen ist in comment.js hinterlegt. Listing 4 enthält dazu die Funktionsskelette, die alle implementiert werden müssen. Die Funktionsnamen erklären sich selbst und zeigen, dass ein solches Modul das Erstellen, Aktualisieren, Löschen und Zählen von Kommentaren zu einer Seite oder zu einem Nutzer ermöglicht.Listing 2: Beispielhafte Definition eines Moduls
key: module-name <br/>title: Beispiel-Modul für Seitenkommentare <br/>author: Fabian Deitelhoff <br/>logo: https://... <br/>website: https://... <br/>codeTemplate: true <br/>isAvailable: true <br/>props: <br/> firstExampleProperty: String <br/> secondExampleProperty: Number Listing 3: Beispiel für die Datei code.yml
main: | <br/> &lt;div id="external_thread"&gt;&lt;/div&gt; <br/>body: | <br/> &lt;script&gt; <br/> var something = remote() <br/> &lt;/script&gt; Listing 4: Der Aufbau der Datei comment.js
module.exports = { <br/> async create ({ pageId, replyTo, content,<br/> guestName, guestEmail, user }) { <br/> // Code to create a comment here... <br/> }, <br/> async update ({ id, content, user }) { <br/> // Code to update a comment here... <br/> }, <br/> async remove ({ id, user }) { <br/> // Code to delete a comment here... <br/> }, <br/> async count ({ pageId }) { <br/> // Code to get the comment count for a page... <br/> } <br/>}
Für den Zugriff auf die Daten von Wiki.js gibt es eine GraphQL-Schnittstelle. Darüber kann der Zugriff auf alle Ressourcen des Wikis erfolgen. Dazu gehören beispielsweise alle Seiten oder spezifische Seiten, Gruppen, Nutzer und dergleichen. Listing 5 zeigt dazu eine Abfrage, um eine einzelne Seite mit der ID 33 abzurufen, die nur die Eigenschaften path, title, createdAt und updatedAt zurückgibt.
Listing 5: GraphQL-Query zum Abrufen von Daten
{ <br/> pages { <br/> single (id: 33) { <br/> path <br/> title <br/> createdAt <br/> updatedAt <br/> } <br/> } <br/>} Alternative Wiki-Systeme
Es gibt viele andere Systeme, die als Alternativen zu Wiki.js in Betracht gezogen werden können, wie zum Beispiel MediaWiki, DokuWiki, TiddlyWiki, Confluence, XWiki, BookStack, Notion, GitBook, Zoho Wiki und einige weitere. Jedes dieser Systeme hat seine eigenen Stärken und Schwächen, abhängig von den Anforderungen und Präferenzen der Nutzer. Daher ist die Auswahl eines geeigneten Systems gar nicht so einfach und im Zweifel ziemlich aufwendig. Die nachfolgende Übersicht beschreibt einige der bekanntesten Wiki-Systeme und listet auf, wofür diese jeweils bekannt sind.- MediaWiki: MediaWiki ist die Open-Source-Software, die Wikipedia antreibt. Es ist eine leistungsfähige und skalierbare Lösung, die PHP verwendet, um Daten in einer Datenbank wie MySQL zu verarbeiten und anzuzeigen.
- DokuWiki: DokuWiki ist eine einfach zu bedienende und vielseitige Open-Source-Software, die keine Datenbank benötigt. Es ist besonders für das Erstellem von Dokumentationen geeignet und verfügt über eine saubere und lesbare Syntax.
- TiddlyWiki: Dieses System arbeitet als einzelne HTML-Datei mit allen Eigenschaften eines Wikis, einschließlich der Bearbeitungs-, Speicher-, Tagging- und Suchfunktionen. Es ist sehr portabel und eignet sich gut für persönliche Notizen und kleine Projekte.
- Confluence: Confluence ist eine kommerzielle Wiki-Software von Atlassian, die sich gut in andere Atlassian-Produkte wie die Jira-Teamsoftware einfügt. Sie bietet eine Vielzahl von Funktionen und Anpassungsmöglichkeiten für Unternehmen.
- XWiki: Diese Open-Source-Software bietet eine erweiterte Anpassungsfähigkeit und eine Vielzahl von Funktionen, einschließlich einer eingebauten Suchmaschine und einer Wysiwyg-Bearbeitung.
- BookStack: Eine kostenlose Open-Source-Wissensmanagement-Plattform, die auf PHP basiert. BookStack ist einfach zu bedienen und ermöglicht die Organisation von Inhalten in Büchern, Kapiteln und Seiten.
- Notion: Notion ist eine All-in-One-Plattform, die Notizen, Aufgaben, Wikis und Datenbanken kombiniert. Es ist sowohl für persönliche als auch für geschäftliche Anwendungen geeignet und bietet eine intuitive Nutzeroberfläche und leistungsstarke Funktionen.
- GitBook: Diese Plattform zum Erstellen und Verwalten von Dokumentationen und Wissensbasen hat eine nutzerfreundliche Oberfläche und ermöglicht die Zusammenarbeit in Echtzeit.
Fazit
Wiki.js ist eine moderne und anpassbare Open-Source-Wiki-Software, die gut zu den unterschiedlichsten Projekten passt. Mit einer nutzerfreundlichen Oberfläche, verschiedenen Editoren, umfangreichen Anpassungsmöglichkeiten und einer Vielzahl von Funktionen sowie Modulen bietet Wiki.js eine attraktive Alternative zu traditionellen Wiki-Engines. Die einfache Installation und die Kompatibilität mit verschiedenen Datenbanken ermöglichen es, Wiki.js in der bevorzugten Umgebung zu betreiben. Die modulare Struktur und die kontinuierliche Weiterentwicklung der Software gewährleisten, dass Wiki.js stets auf aktuellem Stand ist.Insgesamt ist Wiki.js eine hervorragende Wahl für alle, die eine effiziente und nutzerfreundliche Wiki-Software suchen, die den aktuellen Anforderungen und Trends genügt. Die zahlreichen Vorteile von Wiki.js machen es zu einer empfehlenswerten Lösung für das Wissensmanagement und die Zusammenarbeit in verschiedenen Anwendungsfällen.Fussnoten
- Wiki.js, https://js.wiki
- Wiki.js bei GitHub, http://www.dotnetpro.de/SL2403Wikijs1
- Wikitext bei Wikipedia, http://www.dotnetpro.de/SL2403Wikijs2
- Algolia, http://www.algolia.com/de/
- Azure Search, http://www.dotnetpro.de/SL2403Wikijs3
