In Bearbeitung

Pünktlich zum Ende dieses spannenden Jahres, wollen wir Ihnen einige Einblicke in unsere tägliche Arbeit geben ;)

In dieser mehrteiligen Serie wollen wir Ihnen Hintergrundinformationen zu den Werkzeugen geben, mit denen wir täglich arbeiten. Viele dieser Werkzeuge wurden in teilweise langjähriger Arbeit selbst entwickelt und immer weiter optimiert. Das nach außen hin offensichtlichste Tool, mit dem Sie als Shopware Shopbetreiber in Kontakt kommen, ist sicherlich unser Wiki. Aber wie funktioniert das genau? Schauen wir uns zunächst einmal an, wie sich das Wiki in den letzten Jahren entwickelt hat.

Die Dokumentation spielt bei Shopware seit jeher eine sehr wichtige Rolle. 2003 haben wir die erste Version von Shopware veröffentlicht, die man aber nicht offiziell erwerben konnte. Viel mehr, wurde diese Version ausschließlich in Projekten eingesetzt. Für die Nostalgiker unter uns, hier 2 Screenshots des alten Backends ;)

Statt einer umfangreichen Dokumentation, gab es bei dieser Shopware Version mehrtätige Schulungen, um die neuen Shopbetreiber mit dem System vertraut zu machen. Die Hilfe wurde in Form eines 30 seitigen PDF-Dokuments bereitgestellt. Das hat "damals" tatsächlich noch gereicht, da die Software natürlich weitaus weniger komplex war als heute.

Auch zu diesem Zeitpunkt existierten schon Pläne, die Software irgendwann als Standardprodukt für die breite Masse bereitzustellen.

Gesagt, getan. Nach mehreren Minor-Releases der 1.er Reihe, konzentrierten wir uns seit 2005 ganz auf die Entwicklung von Shopware 2. Unser wichtigstes Ziel bei der Neu-Entwicklung: Ein extrem einfach und intuitives Backend und ein sauberes Frontend, welches dem Shopbetreiber leistungsstarke Marketing-Möglichkeiten an die Hand gibt.

Die erste Version von Shopware 2 wurde im Mai 2007 veröffentlicht. Statt eines Wikis, war jedes Fenster im Backend mit einem dazu passenden Hilfetext versehen, der sich per Mausklick aufrufen ließ.

Natürlich war es schwierig, diese Hilfe kontinuirlich aktuell zu halten. Dadurch, dass der Text fest in die Software eingebunden gewesen ist, konnte die Hilfe auch nicht adhoc aktualisiert werden.

Parallel gab es ein ca. 100 seitiges PDF-Dokument (Große Schrift ;)), welches die wichtigsten Schritte zur Einrichtung des Systems beschrieb. Auch hier war das größte Problem, dass die Offline-Hilfe mit jedem neuen Release kompliziert aktualisiert werden musste und die Hilfe permanent hinter der wachsenden Komplexität der Software zurückblieb

Also haben wir uns zusammengesetzt und überlegt, wie wir zukünftig alle Informationen und Hilfen rund um Shopware bereitstellen wollen - zu diesem Zeitpunkt war Wikipedia in aller Munde, so war ziemlich schnell klar, dass die neue Hilfe nach dem Wiki-Prinzip aufgebaut sein soll um diese einfach und schnell kontinuirlich aktuell halten zu können.

Aufgebaut haben wir das erste Wiki auf Basis der Software "MediaWiki" (http://www.mediawiki.org/wiki/MediaWiki) - diese wird u.a. auch für die Realisierung von Wikipedia verwendet. Im ersten Step haben wir alle bereits verfügbaren Hilfetexte dorthin übertragen und sich dann relativ schnell online gegangen.

So sah das Wiki kurz nach Launch im Februar 2008 aus:

Gegenüber der ersten Version der Hilfe schon ein riesiger Fortschritt, denn so konnten wir die Hilfe rund um Shopware stetig erweitern und aktuell halten. In den dann folgenden Monaten kristalisierten sich einige Nachteile dieser Lösung heraus - im wesentlichen:

• Zur Anpassung des Wikis (Template & Code) mussten eigene Ressourcen geschaffen werden, das Wissen was wir hier aufgebaut haben, ließ sich nicht auf Shopware adaptieren. Sprich wir mussten viele Mannstunden Entwicklung aufbringen, ohne dass daraus ein genereller Vorteil für das Unternehmen entstanden wäre
• Die Kategorisierung und die Such-Funktion des Original-Wikis haben uns nicht zufrieden gestellt. Die Informationen waren schlecht bis garnicht auffindbar.
• Layout & Optik genügte unseren Ansprüchen nicht - die verwendeten Templates waren nur äußerst kompliziert anzupassen (Vor allem, wenn man ein komplettes Redesign des Wikis anstrebt)

Alles in allem haben wir uns gegen Ende 2008 konkrete Gedanken gemacht, wie wir das Wiki auf Basis Shopware neu aufbauen können. Ziel war es, unsere in diesem Bereich verfügbaren Ressourcen auch 1 zu 1 für die Weiterentwicklung der Dokumentation nutzen zu können, ohne das wir unsere Entwickler zusätzlich auf die Programmierung des Mediawikis schulen müssen.

Ein wesentlicher Vorteil des Wikis gegenüber Shopware, war die einfache Formatierung von Texten - statt kompliziert mit einem WYSIWYG-Editor arbeiten zu müssen, muss man sich bei der Wiki-Syntax nur eine Handvoll von Formatierungsanweisungen merken. Jeder Text sieht automatisch gleich aus und viele Elemente, zur sinnvollen Gruppierung der Texte, werden automatisch erzeugt. Irgendwie mussten wir also den Parser des Original-Wikis in Shopware integrieren.

In Step 1 habe ich überprüft, ob es eventuell bereits einen frei verfügbaren Wiki2Html Parser gibt, der unseren Ansprüchen genügt. Das war zur damaligen Zeit leider nicht der Fall. Also habe ich das Original-Wiki auseinander genommen und die Komponenten, die zur Erzeugung der Artikel im Frontend zuständig sind, in eine neue Klasse übertragen. Das hört sich nun recht einfach an;) Wenn man aber bedenkt, dass das Mediawiki aus einigen zehntausend Zeilen Quellcode und sehr vielen Abhängigkeiten besteht - wird die Komplexität dieses Vorhabens deutlich. Nach ca. 3 Wochen stand intern der erste Prototyp - die Texte konnten direkt aus dem Shopware Backend heraus erstellt werden und wurden im Frontend automatisch korrekt formatiert angezeigt. Perfekt! Nachdem der Parser und das Layout im Frontend soweit optimiert wurden, dass das Ergebnis 1 zu 1 der Original-Wiki-Struktur entsprach, haben wir Schritt für Schritt weitergehende Funktionen eingebunden. Als erstes haben wir den TinyMCE in der Backend-Eingabe, durch "editArea" ersetzt - also einem Code-Editor. Dadurch hat sich die Artikelpflege noch einmal erheblich vereinfacht. Im nächsten Schritt haben wir einen Konverter programmiert, mit wir die bestehenden Artikel aus dem Original-Wiki in Shopware importieren konnten. Diese wurden dort nachbearbeitet und über das Kategorien-System verknüpft.

Alles in allem hat der gesamte Umstellungsprozess ca. 4 Wochen benötigt - seit Anfang 2009 ist das Wiki also auf Shopware-Basis online. Danach wurde das System Step by Step ausgebaut - hier mit dem Vorteil, dass das dazu notwendige Wissen bereits im Unternehmen vorhanden ist und sich niemand mehr in die Architektur eines Drittsystems einarbeiten musste.

Schauen wir uns das Endergebnis einmal an:

Die Stammdaten Maske ist perfekt auf die Verwaltung von Content hin optimiert worden. Der TinyMCE - Editor ist durch einen Plaintext-Editor ersetzt worden.

Im Frontend können Artikel direkt editiert werden - man muss also nicht in das Backend, um Artikel bearbeiten zu können.

Die Übersicht der Artikel zeigt an, wie die Artikel durch die Leser bewertet werden. So kann man optimierungsbedürftige Artikel Step by Step verbessern.

Alle Vorschläge werden zentral gesammelt und von dort aus freigeschaltet bzw. kommentiert. Außerdem ist das System an unseren Bugtracker (Trac!) angeschlossen - so dass man Tickets in beide Richtungen synchronisieren kann. Dadurch kann das gesamte Feature-Voting komplett aus dem Wiki heraus durchgeführt werden, ohne das man hier ein Drittsystem benötigt!

In den Details werden die Tickets den passenden Milestones zugewiesen und ggf. kommentiert.

Artikel können umfangreicher ais in der normalen Shopware bewertet werden - so bekommen wir viel Feedback von unseren Lesern und können die Dokumentation immer weiter optimieren.

=== Die Wiki-Syntax ===

Die Texte werden über einfache Formatierungsanweisungen formatiert - Content-Elemente wie das Inhaltsverzeichnis werden hierbei automatisch generiert. Bilder fügt man z.B. einfach per

[img|0|5]

in den Text ein. Sprich der Upload wird wie im Shopware Standard durchgeführt, die Platzierung im Content über einfache Tags!

• Anbindung PHPBB / Forum
• Single-Signon (Shopware ID / ein zentraler Login für alle Subsysteme)
• Verschiedene Seiten-Templates für die unterschiedlichen Bereiche
• Diverse Kategorien-Darstellungen / z.B. alphabetische Gruppierung aller Kategorie-Artikel
• Automatischer Newsletter mit allen Neuerungen
• Public Changelog
• Einbindung Videocasts / Downloads

Der wichtigste Vorteil für uns ist, dass wir alle Informationen, Dokumentationen, Support und Unterstützung unter einer zentralen, einheitlichen Plattform anbieten können. Viele andere Anbieter fragmentieren Ihre Community, in dem die Informationen auf viele, verschiedene Seiten und Portale verteilt werden. Durch die zentrale Integration aller Funktionen in einer Plattform, stehen alle Daten in einem einheitlichen Frontend zur Verfügung.

Die Technik im Hintergrund baut vollständig auf Shopware auf - so können Entwicklungen die für das Wiki vorgenommen wurden zentral zurück in den Entwicklungszweig von Shopware fließen und umgekehrt. Eine Win-Win Situation, da hierbei keine Ressourcen in andere Richtungen / Bereiche gesteckt werden müssen.

Auch in 2011 haben wir viel vor, was den weiteren Ausbau unserer Community betrifft.

• Im Dezember launchen wir den CommunityStore - ebenfalls komplett eingebunden, in die bestehenden Community Strukturen
• Ab Anfang des Jahres, können auch Shopbetreiber und Partner zu Co-Autoren werden und eigene Artikel zum Wiki beisteuern
• Ebenfalls können bestehende Artikel bearbeitet werden und verfügen über eine Revisionsansicht, ähnlich dem Original-Wiki
• Veröffentlichung des Wikis als eigene Software
• Bereitstellung des Parsers und des Code-Editors als Shopware Plugin
• uvm. ;)