Die vorliegende Online-Dokumentation basiert auf dem WordPress-Plugin Smart Docs und dient als zentrale Hilfe für die redaktionelle Arbeit mit den Websites des IMAREAL. Hier werden die wichtigsten Arbeitsabläufe und Besonderheiten der Website dokumentiert. Die Dokumentation ist bewusst praxisorientiert aufgebaut und versteht sich nicht als vollständiges WordPress-Handbuch.
Zweck des Wikis#
Das Wiki soll Redakteurinnen und Redakteuren ermöglichen, häufig benötigte Informationen und Anleitungen selbstständig nachzuschlagen.
Dokumentiert werden insbesondere:
- grundlegende Arbeit mit WordPress,
- Bearbeitung und Gestaltung von Inhalten,
- Besonderheiten der IMAREAL-Website,
- spezielle Inhaltstypen und Plugins,
- redaktionelle Regeln,
- Besonderheiten der MEMO-Website.
Für allgemeine WordPress-Funktionen werden nur jene Aspekte behandelt, die für die tägliche Arbeit relevant sind.
Aufbau der Dokumentation#
Die Dokumentation ist in Hauptkapitel gegliedert. Jedes Hauptkapitel enthält mehrere thematisch zusammengehörende Artikel.
Auf der Startseite werden die Hauptkapitel als eigene Bereiche dargestellt. Von dort können die einzelnen Artikel direkt geöffnet oder über „View All“ alle Artikel eines Kapitels angezeigt werden.
Suche#
Im oberen Bereich des Wikis steht eine Suchfunktion zur Verfügung. Über diese können die Artikel der Dokumentation nach Begriffen durchsucht werden. Gerade bei konkreten Fragen ist die Suche häufig der schnellste Weg zum entsprechenden Abschnitt. Geeignete Suchbegriffe sind beispielsweise „Bild“, „WPBakery“, „Übersetzung“, „Team“ oder „Pure“.
Pflege der Dokumentation#
Die Inhalte dieser Dokumentation werden ausschließlich durch die N3XT GmbH erstellt und bearbeitet. Redakteurinnen und Redakteure müssen daher keine Smart-Docs-Seiten selbst anlegen, bearbeiten oder strukturieren.
Fehlen Informationen, ist eine Anleitung nicht mehr aktuell oder besteht zusätzlicher Dokumentationsbedarf, sollte dies an die N3XT GmbH weitergegeben werden. Die entsprechende Änderung wird anschließend zentral in die Dokumentation eingepflegt. Dadurch bleibt der Aufbau des Wikis einheitlich und es wird vermieden, dass unterschiedliche oder widersprüchliche Anleitungen entstehen.