Lucidworks Enterprise: Praktische Dokumentation
Mit der weltweiten Einführung von Lucidworks Enterprise haben wir auch ein neues Online-Dokumentationssystem eingeführt. Dabei handelt es sich um das vollständige Produkthandbuch, in dem alle Funktionen von Lucidworks Enterprise dokumentiert sind.
Was wir getan haben
In den ersten Versionen von Lucidworks Enterprise (die nur in sehr begrenztem Umfang vertrieben wurden) war die Dokumentation im DocBook-Format und das Benutzerhandbuch wurde während des Produktentwicklungsprozesses erstellt. Dies war eine leistungsstarke und integrierte Lösung, die jedoch für Nicht-Programmierer schwer zu handhaben war. Um auch nur geringfügige Änderungen an der Dokumentation vorzunehmen, mussten wir einen völlig neuen Build der Software erstellen.
Noch bevor wir uns entschieden hatten, Lucidworks Enterprise für Entwickler zum freien Download bereitzustellen, wussten wir, dass wir unsere Dokumentation für Kunden online zugänglich machen wollten. Idealerweise würden wir das Benutzerhandbuch bei Bedarf außerhalb des Software-Release-Zyklus aktualisieren können. Außerdem gefiel uns, dass MySQL seinen Kunden die Möglichkeit bietet, die Seiten der Dokumentation zu kommentieren und so eine Gemeinschaft von Benutzern zu schaffen, die sich gegenseitig bei der Lösung gemeinsamer Probleme helfen können.
Nachdem wir beschlossen hatten, Lucidworks Enterprise kostenlos zur Verfügung zu stellen, war uns klar, dass auch der Leitfaden für jedermann einsehbar sein musste, obwohl wir beschlossen hatten, Kommentare nur registrierten Benutzern zugänglich zu machen.
Wir haben uns für Confluence als Engine für das Benutzerhandbuch entschieden, das wir seit etwa 9 Monaten als internes Entwicklungs-Wiki verwenden. Als wir uns Confluence als Publikationstool näher ansahen, stellten wir fest, dass wir damit alle unsere Ziele erreichen konnten, ohne dass wir zusätzliche Verwaltungsebenen einführen mussten, die ein vollwertiges CMS-System mit sich bringen würde (was wir zu diesem Zeitpunkt wirklich nicht brauchen).
Vorteile für Sie (und uns)
Die Dinge sind nie so einfach, wie man es sich erhofft (die Konvertierung von DocBook zu Confluence ist eine Erfahrung, die ich lieber nicht wiederholen möchte, obwohl der Doxia Converter eine große Hilfe war), aber wir konnten ein kohärentes Benutzerhandbuch erstellen und es mit minimalen Programmierressourcen veröffentlichen. Wir sind ein agiles Entwicklungsteam und unsere Dokumente müssen bei häufigen Veröffentlichungen sofort einsatzbereit sein. Indem wir unser Benutzerhandbuch in ein Wiki umgewandelt haben, können wir die Seiten schnell aktualisieren und die neue Software noch schneller auf den Markt bringen.
Obwohl wir das Benutzerhandbuch mit Lucidworks Enterprise als PDF-Datei und HTML-Seiten verpacken, betrachten wir diese als Momentaufnahmen des Handbuchs, die schon einen Tag später veraltet sein können. Wir rechnen natürlich nicht so schnell mit größeren Änderungen, aber es ist sehr interessant, dass wir unsere Dokumentation aktualisieren und Ihnen in Echtzeit zur Verfügung stellen können.
Hands on doc
Wenn Sie sich anmelden, können Sie Kommentare zu jeder Seite abgeben. Ihre Kommentare und Fragen werden für andere Benutzer, die vor Ihnen waren, aufschlussreich sein. Auf diese Weise erfahren wir auch, welche Teile der Dokumentation oder sogar unserer Anwendung für Sie am schwierigsten sind und können Verbesserungen in diesen Bereichen planen. Sie können Seiten auch per E-Mail oder RSS auf Aktualisierungen überwachen (klicken Sie auf das Menü Extras, um E-Mails zu erhalten, klicken Sie auf Durchsuchen -> Erweitert, um einen RSS-Feed zu abonnieren).
Was kommt als Nächstes?
Obwohl das Benutzerhandbuch das meiste abdeckt, was Sie für die Verwendung von Lucidworks Enterprise benötigen, gibt es Raum für weitere Details und Erklärungen. Es wird auch nicht sehr oft auf das Innenleben von Solr oder Lucene verwiesen. Wir planen daher, das Solr-Referenzhandbuch in den kommenden Monaten in diesem Format neu zu veröffentlichen. Und natürlich wird es im Laufe des Jahres 2011 neue Software-Releases von Lucidworks Enterprise geben, so dass wir diese regelmäßig aktualisieren werden. Lassen Sie uns in der Zwischenzeit wissen, was Sie davon halten und wie wir es noch besser auf Ihre Bedürfnisse abstimmen können.