DOQO#1: Qualitätsoffensive für die Admin-Dokumentation

DOQO#1 Wenig auf der Welt ist wirklich perfekt. Oder anders gewendet: Es gibt immer was zu tun. Meist so viel, dass man gar nicht weiß, wo man anfangen soll und dann liegt viel Angefangenes herum und wartet darauf, perfekt – oder zumindest: fertig – zu werden. So ähnlich ist auch der Gesamtzustand der Stud.IP-Dokumentation. Stud.IP ist ein lebendiges Software-Projekt, das sich schnell weiterentwickelt, das angesichts der vielen Ideen und Baustellen bei der Dokumentation immer an ein wenig zu wenig leidet: Zu wenige Mitschreiber, zu wenig Zeit, vor dem nächsten Release die Überarbeitung abgeschlossen zu haben.

Seit 2006 ist die Stud.IP-Anwenderdokumentation nicht mehr Teil der Distribution, sondern wird zentral in einem Wiki gepflegt: http://hilfe.studip.de. Die damals verfolgten Grundideen sind aufgegangen: Viele lokale Anstrengungen, eine bessere Stud.IP-Dokumentation zu schreiben konnten zusammengeführt werden. Jetzt profitieren alle davon, weniger Arbeit wird doppelt gemacht und es ist eine zentrale Anlaufstelle für die Dokumentation entstanden. In gewisser Weise war das Vorhaben erfolgreicher als gedacht: Nicht nur die Anwender-Dokumentation, sondern auch neue Admin-, Entwickler- und Plugin-Dokumentationsecken sind entstanden. Das alte Hilfe-Wiki war dafür gar nicht richtig ausgelegt, hat das Prinzip der standortbezogenen Sichten zu weit gefasst und zu wenig transparent gemacht: In Teilen der Hilfe war eher chaotisches Wuseln als planvoll gehegtes Wachsen an der Tagesordnung.

Jetzt wird alles noch besser! Mit dem neuen Dokumentations-Portal, das pünktlich zum Release von Stud.IP 2.0 an den Start gegangen ist, werden die verschiedenen Dokumentations-Teile sauberer getrennt, das Layout ist moderner und lecht sich soweit wie möglich an das Stud.IP-Portal an. Nun, da die Technik einigermaßen rund läuft, kann es ans Eingemachte, also die Inhalte gehen.

Seit dem 22.2. läuft die Dokumentations-Qualitätsoffensive DOQO. Jeden Monat nehmen wir uns ein Stück der Stud.IP-Dokumentation vor, sortieren, entrümpeln, korrigieren, ergänzen und polieren sie.

Den Anfang macht die Admin-Dokumentation unter http://docs.studip.de/admin. Hier erfahren Stud.IP-Betreiber, wie sie eine eigene Installation von Stud.IP aufsetzen, welche Konfigurationsoptionen es gibt und wie das eigene Stud.IP so eingerichtet werden kann, dass zu den Gegebenheiten vor Ort passt. Die Admin-Dokumentation wendet sich also weder an Dozenten, noch Studenten oder Software-Entwickler, sondern an Rechenzentren, E-Learning-Support-Einrichtungen und natürlich auch all die Experimentierwilligen, die sich ein eigenes Stud.IP zu Test- und Versuchszwecken halten wollen.

Wir haben uns vorgenommen, in den nächsten 4 Wochen endlich einmal eine vollständige und aktuelle Admin-Dokumentation zu schaffen. Die allermeisten Informationen sind schon vorhanden, aber in den Tiefen der Stud.IP-Developer-Foren verstreut. Lasst sie uns zusammentragen und einem der Hauptprobleme der Stud.IP-Betreiber begegnen: Dass eigentlich all ihre Wünsche erfüllbar sind, sie aber die richtigen Zaubersprüche nur nicht finden.

Wer mitmachen will, aber noch keinen Bearbeitungs-Account hat, wende sich bitte an Tobias Thelen.

Und hier geht’s aufs Schlachtfeld: http://docs.studip.de/admin.

3 thoughts on “DOQO#1: Qualitätsoffensive für die Admin-Dokumentation

  1. Edith Werner

    Wird an der Dokumentation eigentlich noch gearbeitet?

    Auf der Doku-Website steht als Datum der meisten Seiten irgendwas im Februar – jetzt ist Juni, und die Info die ich bräuchte (Dokumentation des Export-Moduls) fehlt leider.

  2. Tobias Thelen Beitragsautor

    An der Dokumentation wird an ganz verschiedenen Stellen gearbeitet, die DOQO-Überarbeitung der Admin-Doku ist abgeschlossen. Vielen Dank für den Hinweis, dass das Export-Modul dort noch fehlt. Ein bisschen Dokumentation gibt es in der Anwender-Dokumentation:

    http://docs.studip.de/help/2.0/de/Basis/Export

    sowie auf den Export-Seiten selbst.

    Fragen, die die Hilfe nicht beantwortet, dürfen sehr gerne im Entwickler- und Anwenderforum auf dem Entwicklungsserver unter http://develop.studip.de/studip/index.php gestellt werden und werden in der Regel sehr schnell beantwortet.

  3. Sabine

    Man spürt richtig, wie Ihr für die Sache brennt und dafür kämpft, dass am Ende etwas Brauchbares dabei herauskommt. Die richtigen Zaubersprüche für Wunscherfüllungen zu kennen oder zu(er-)finden, ist euch vermutlich auch nicht so leicht gefallen. Ich mach mich jetzt mal auf die Suche nach dokumentierten Ergebnissen Eures Bemühens und schau mal, was ich davon für mich, bzw. mein eigenes Projekt verwenden kann.

Schreibe einen Kommentar

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

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.