Code-Dokumentation

Die Dokumentation von Software ist fast schon eine Kunstform und nicht selten entscheidet sie über Erfolg oder Misserfolg eines Produkts. Für populäre Plugins wie WooCommerce oder Easy Digital Downloads werden unzählige Stunden Arbeitszeit auf die Produktion und Pflege verständlicher Anwender- und Entwickler-Dokumentation verwendet. Aber auch manche Angebote freier Entwicklerinnen und Entwickler bieten durchdachte Dokumentationen an.

Florian Brinkmann hat sich die Mechanik hinter der neuen WordPress-Developer-Doku für seine eigene Code-Referenz angeschaut.

 

Code-Referenz à la developer.wordpress.org erstellen

 

Kat Christofer arbeitet für Automattic und kümmert sich dort um die Dokumentation des e-Commerce-Plugins WooCommerce und dessen diverser Addons. Auf der WooConf in Seattle hat Kat diese Grundlage genutzt um ihr Publikum in einem Vortrag in die Kunst der Dokumentierens einzuführen. Die Folien zum Vortrag sind bereits online.

 

Why & How to Create Docs that Rock

Plädoyer für einen Redaktions-Account

Ähnlich wie Christopher Kurth habe ich mir auf WordPress-Seiten in der Vergangenheit selten einen zweiten Account angelegt. Ich vertraue in einem Maß auf meine Sicherheitsvorkehrungen, dass ich das nicht als zusätzliche Sicherheitsmaßnahme einsetzen wollte.

 

Christopher hat sich im Frühjahr aber aus einem ganz anderen Grund für einen Zweitaccount entschieden: Einfachheit. Hat der aktive Account weniger Rechte zur Verwaltung von Plugins, Themes und Einstellungen, ist das Backend einfach aufgeräumter. Keine nervigen und überflüssigen Einträge im Admin-Menü und keine anstrengenden Dialoge zur Seitenadministration. Lediglich zum Ändern von Einstellungen, Hinzufügen weiterer Nutzer oder für das Durchführen von Updates muss in den Account mit vollen Admin-Rechten gewechselt werden.

 

Ist diese Lösung perfekt? Nein sicher nicht. Das Backend lässt sich mit verschiedenen Plugins „aufräumen“ – sprich Überflüssiges kann ausgeblendet werden. Aber weil Christophers Ansatz eben genau ohne ein zusätzliches Plugin auskommt, ist er mir sympathisch.

Weiterführende Informationen →

In eigener Sache: Den LETTER unterstützen

Seit etwas über zwei Jahren betreue ich den WP LETTER. Jede Ausgabe erfordert fast einen kompletten Arbeitstag an Vorbereitung. Seit Sommer 2015 habe ich für den LETTER 15.966 Artikel gelesen, sortiert, priorisiert und kommentiert. Mein Antrieb hinter diesem Projekt war nie, damit reich oder berühmt zu werden – aber mein guter Freund Chris lag mir in den letzten Monaten mit einem Service namens „Steady“ in den Ohren.

 

Auf Steady können Journalisten, Künstler – und Newsletter-Schreiber – unkompliziert  regelmäßige Spenden von Leserinnen und Lesern einsammeln. Nachdem Chris nun lange genug auf mich eingewirkt hat, starte ich einfach einen kleinen Probelauf, was kann schon schlimmes passieren?

 

Mit Beträgen ab einem Euro pro Monat könnt ihr meine Arbeit hier etwas unterstützen und dafür sorgen, dass ich mehr Zeit für den LETTER habe, weil ich mir weniger Sorgen machen muss, wie ich meine Miete zahle. Wer nicht zahlen will oder kann: Auch kein Problem, der LETTER wird weiterhin kostenfrei bleiben und ich freue mich auch weiterhin über die eine oder andere Weihnachtskarte, wie einige sie in den letzten Jahren schon geschrieben haben.

Die WP LETTER Steady-Kampagne →

WP Meetups der Woche

Short News