Aufbau der Dokumentation

In den letzten Tagen bin ich das Thema Dokumentation und Support angegangen. Ich würde euch gerne kurz vorstellen, wie ich mir das so gedacht habe. Vielleicht habt ihr ja noch ein paar Verbesserungsvorschläge / Anmerkungen.

Die Dokumentation muss im Prinzip zwei Zielgruppen erreichen. Die größere sind, die normalen Nutzer, die den Umgang mit dem CMS erlenen möchten. Auf der anderen Seite sind (Plugin-)entwickler, die das System erweitern möchten und auf der gezielten Suche nach Systemdetails sind.

Aus diesem Grund habe ich mir folgendes ausgedacht: Wir bieten auf der Startseite der Doku zum einen Tutorials (“Installation”, “Die erste Seite erstellen”,…) und zum anderen strukturierte Informationen zu unseren Objekten (Benutzer, Seitentypen,…) an.

Zu den strukturierten Informationen gehört dann zum Beispiel auch die Dokumentation von Events, die man zur Plugin-Erweiterung nutzen kann.

Die Dokumentation zu den einzelnen Plugins findet auf der Plugin-Seite statt, wo man das Plugin auch herunterladen kann. Sie wird natürlich stark mit der allgemeinen Dokumentation vernetzt werden.

In-System Dokumentation

Die Dokumentation wird auch mit ContentLion selbst verknüpft. Ich habe bereits eine Möglichkeit, nach bestimmten Tagen dem Benutzer Nachrichten anzuzeigen. So kann man dem Benutzer nach und nach eine kleine Einführung ins System geben.

Außerdem werden einzelne Seiten mit einem Hilfe-Button ausgestattet, der dann die Online-Doku öffnet. So können wir direkt an der Problemstelle helfen.

Support-Forum

Zurzeit landen alle Fragen bzgl. ContentLion in meinem Mail-Postfach, meinem Facebook-Account usw. Ich würde diese gerne in einem Forum bündeln. Denn jetzt haben wir noch einen kleinen Nutzerkreis und ich verbringe schon ordentlich viel Zeit damit Vorschläge zu prüfen und Hilfestellung bei der Installation und Benutzung zu geben.

Das Forum wird wenn alles klappt zweisprachig, genauso wie das CMS selbst. Es könnte evtl. auch schon vor der Beta online gehen.

In meiner Entwicklungs-Version ist übrigens für die Beta eine Feedback-Seite. Dort können Vorschläge und Probleme notiert und auf Wunsch PHP-Konfigurationen an mich versendet werden. Hier muss ich mir noch überlegen, wie ich das später handle.

Dieser Beitrag wurde unter Planung veröffentlicht. Setze ein Lesezeichen auf den Permalink.

Hinterlasse eine Antwort

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind markiert *

*

Du kannst folgende HTML-Tags benutzen: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>