FHEMWiki:Wiki-Strukturierung

Aus FHEMWiki
Wechseln zu: Navigation, Suche

Einleitung

Diese Seite soll dazu dienen eine geeignete Struktur das FHEMWikis zu entwickeln.

Sie soll auch die entsprechende Grundsatzdiskussion in FHEMWiki_Diskussion:Über_FHEMWiki#Grundsatz-Diskussion_Wiki-Strukturierung ablösen bzw. ergänzen.


Hintergrund

Aktuelle Situation

Wir haben derzeit >400 Artikel und >70 Kategorien zu allen möglichen Themen im Wiki - Tendenz deutlich steigend. Das ist super, nur ist es derzeit nicht wirklich möglich sich darin (strukturiert) zurechtzufinden. Das ist aber das generelle Problem eines Wikis.

Benötigte Sichten

Auf unser Wiki benötigen wir folgende Sichtweisen:

  • User-Sicht - Sichtweise der User, um sich im Wiki inhaltlich/thematisch zurecht zu finden
  • Administrative Sicht - Sichtweise der Autoren und Administratoren, um das Wiki zu pflegen


Generelle Lösungsansätze für eine bessere Übersicht

Um eine bessere Übersicht zu erlangen gibt es folgende generellen Lösungsansätze (ohne die eigentlichen Artikel-Seiten):

  • User-Sicht:
    • Redaktionelle Seiten
      • haben wir in Form der div. Themenseiten, die von der Wikistartseite zugänglich sind (Anwendungsszenarien ...).
      • müssen ständig gepflegt werden damit sie aktuell bleiben. Das funktioniert in einem hauptberuflich administierten Wiki wie Wikipedia, ist von uns aber nicht sinnvoll zu leisten (meine Einschätzung).
    • Kategorien
      • haben wir automatisch nach Bedarf
      • sind (weitestgehend) selbstpflegend, nur haben wir derzeit keine strukturierte Übersicht über die Kategorien (die Seite Spezial:Kategorien hilft da auch nicht wirklich).
  • Administrative Sicht:
    • Spezialseiten des Wikis
      • sind automatisch vorhanden
      • sind prinzipiell ausreichend, ihre Aussagekraft hängt aber von der gewählten Wiki-Struktur ab. Bspw. sind die in Spezial:Verwaiste_Seiten gelisteten Seiten mit Kategorien versehen - sie sind also nicht völlig verweist, sondern nur nicht aus anderen Artikeln referenziert.
    • FHEMWiki:xxx-Seiten, wie diese
      • werden nach Bedarf erstellt
      • müssen, wie alle Seite, gepflegt werden


Vorschlag einer Wiki-Struktur

Dieser Vorschlag betrifft nur die User-Sicht, da die Admin-Sicht ausreichend bedient ist (s.o.).

Grundgerüst

Die Grundstruktur des Wikis sollte 4-stufig sein:

1. Startseite
2. Themen-Seiten
3. Kategorien-Seiten
4. Artikel

Elemente

Startseite

Die Startseite ist, wie bisher, eine redaktionell betreute Seite, die nur durch die Administratoren gepflegt wird. Sie sollen einen guten Einstieg in das Wiki bieten. Dazu verschiedenen Themen-Seiten verlinkt.

Themen-Seiten

Die Themen-Seiten sind redaktionell betreute Seiten, die übergreifendere Themen betreffen (bspw. "Hardware", "Software", "Anwendungsszenarien", "Reelle Installationen", ...) und auf entsprechende Bereiche verlinken. Technisch gesehen, sind es Kategorien-Seiten mit einführendem Artikeltext, verlinken aber nur zu den eigentlichen relevanten Kategorien-Seiten und idR. nicht zu einzelnen Artikeln. Themen-Seiten sind eher mit Portalen zu vergleichen.

Kategorien-Seiten

Die Kategorien-Seiten sind, wie bisher, Sammlungsseiten für Artikel. Allerdings sollten sie möglichst immer um einen Artikeltext ergänzt werden, der eine generelle Einführung in das Thema der Kategorie gibt. Existierende Bsp.: Kategorie:1-Wire, Kategorie:FritzBox. Für etliche andere Kategorien gibt es bereits separat gepflegte Einführungsartikel, bspw. Kategorie:EnOcean_Components und EnOcean Starter Guide (Kap. 1+2). Kategorien dürfen auch in anderen Kategorien vernetzt sein.

Artikel

Die Artikel sind, wie bisher, die eigentlichen Inhalte des Wikis. Einzig generelle Thema-Einführungen sollten (wenn möglich) in die entsprechende Kategorie verschoben werden.


Vorteile dieses Ansatzes

Die beschriebene Strukturierung mit Themen- und "erweitereten" Kategorien-Seiten ermöglicht bessere Navigation bei weniger Pflegeaufwand:

  • Themen- und Kategorien-Seiten sind jetzt der Haupt-Weg zu einzelnen Artikeln.
    • Die Verlinkung von Artikeln untereinander ist immernoch wünschenswert, aber nicht mehr Voraussetzung damit man Artikel findet.
    • Die bisherige Mühe, Seiten überhaupt sinnvoll auffindbar zu machen (durch möglichst viele Verlinkungen), entfällt, da Kategorien jetzt der Haupt-Weg sind.
  • Einführungen zu Themen und Kategorien sind direkt da, wo man sie braucht,
    • nämlich auf der entsprechenden Seite und nicht mehr in einem Artikel, der gerade in größeren Kategorien schwer zu finden ist
  • Bisherige selten gepflegte (da übergreifende) Seiten, wie bspw. Anwendungsszenarien, "pflegen sich weitestgehend selbst":
    • Sie werden in eine Themen-Seite überführt. Der ins Thema einleitende Text wird zwar wie bisher geschrieben (aber selten geändert). Zu den dort beschriebenen Themenblöcken existieren idR. bereits Kategorien. Deren Verlinkungen und das Hinzufügen weiterer Kategorien zur Themen-Seite stellt nahezu keinen Aufwand mehr dar - sie sind es aber, die diese Themen-Seite interessant und wertvoll machen.
  • Querverweise zwischen Kategorien erleichtern das Finden von Informationen.
  • Die Überführung in die neue Struktur kann schrittweise erfolgen, ohne eine "Cut" machen zu müssen (s.u.).


Beispiel einer Wiki-Struktur

Eine Kategorien-Struktur könnte wie folgt aussehen:

Startseite Themen-Seite Kategorien-Seite Artikel
Startseite Einstieg ...
Hardware Server-Hardware
Komponenten/Devices
Client/Display-Hardware
Sensoren
Aktoren
Software Interfaces
Konfiguration
Anwendungsszenarien Wetter
Heizung
Verbrauchsmessung
Anwesenheitserkennung
Rolladen-/Garagentor-Steuerung
Balkon und Garten
Lüftung und Klima
Multimedia-Integration
Terminerinnerungen und Kalenderintegration
... ...


Notwendige Tätigkeiten zur Umsetzung der Struktur

Einmalige Arbeiten

  • Definieren und erstellen der Themenseiten
    • Überführung der bisher gepflegten Seite in eine Themenseite
    • Verlinkung der relevanten Kategorien
  • Ergänzung der bestehenden Kategorien um Einführungstexte
    • Oft können bestehende Texte aus Artikeln verwendet werden
  • Umgestaltung der Wiki-Startseite entsprechend der neuen Struktur

Ergänzende Arbeiten

  • Anpassen der Spezialseiten oder zumindest Anpassung der administrativen Anleitungen (insb. zu "verwaiste Seiten" und "Sackgassenseiten", vgl. oben).
  • Einige der Hauptlinks auf der Wiki-Startseite sollten ob ihrer Sinnhaftigkeit in der neuen Struktur diskutiert werden und ggf. entsorgt bzw. aufgelöst oder zumindest deutlich umgestaltet werden:
  • Wenn möglich Aktivierung der Sitemap-Funktion des Wiki, und Einbindung in die Startseite