Dokumentation gestartet

von

Auwertung

Vom 10. bis 20. Februar hatte ich auf der Website eine Umfrage zur Verbesserung der Dokumentation geschaltet. Insegamt haben 20 Personen ihr Feedback abgegeben. Ich habe die Antworten ausgewertet und dementsprechend die nächsten Schritte geplant.

Ich möchte mich bei allen bedanken, die sich die Zeit genommen haben an der Umfrage teilzunehmen. Ich habe dadurch Stimmungsbild zu erhalten und kann besser abschätzen, wo noch Nachbesserungsbedarf besteht.

Sehr erfreut bin ich über die hohe Bereitschaft sich in die Dokumentation einzubringen. Insgesamt haben 75% aller Teilnehmer ihre Bereitschaft erklärt, an der Dokumentation mitzuarbeiten. Auf die Frage nach den monatlichen Kapazität kommen in der Summe 48 Stunden zusammen. 

Meine Aufgabe sehe ich nun darin, einzelne Aufgaben der Dokumentation zu delegieren und zu schauen, dass aus der Bereitschaft auch eine tatsächliche Mitarbeit wird.

Die Dokumentation

Basierend auf den Ergebnissen der Umfrage habe ich mir Gedanken zum weiteren Vorgehen gemacht und die Bootstrap Dokumentation ins Leben gerufen. Da ein Großteil der Teilnehmer für ein Handbuch votiert hat, werde ich diese Form der Dokumentation erst einmal fokussieren und schauen ein Team für Blogpost-Anleitungen aufzubauen.

Die Dokumentation wird mittelfristig die Beschreibungen auf der Homepage ersetzen. Sie ist in reStructuredText geschrieben und nutzt Sphinx. Verwaltet wird das Projekt als eigenständiges Git-Repository. Die Dokumentation als HTML wird auf Readthedocs.org veröffentlicht.

Ich habe die verschiedenen Optionen (Ausbau der Website, Übertragung der Dokumentation ins Contao Wiki, eigenständiges Handbuch) überprüft. Dank der Möglichkeiten der einfachen Lokalisierung, Versionisierung, der einfachen Lesbarkeit auch auf Mobilgeräten, der Nutzung einer Drittplattform ohne davon abhängig zu sein, die Möglichkeit leicht PDFs und andere Formate zu generieren, hat mich letztlich davon überzeugt diesen Weg zu gehen.

Mitmachen - Du bist gefragt

Ich habe bereits angefangen die Grundstruktur der Dokumentation zu erstellen sowie erste Inhalte unter Installation, Einführung sowie der Core-Komponente beigetragen. Nun seid ihr an der Reihe, eure Bereitschaft Taten folgen zu lassen.

Die Dokumentation wird vorläufig in Deutsch erarbeitet. Wenn sich genügend Helfer finden und die wesentliche Struktur steht, soll diese auch ins Englische übersetzt werden.

Um die Zusammenarbeit zu koordinieren habe ich in der Contao-Community einen Thread eröffnet. Dort sind die Details zur Mitarbeit erläutert.

 

Zurück