Sperrobjekt Weblog

Warum eigentlich API-Dokumentationen?

Eine gute Dokumentation ist wichtig für jedes Projekt, egal ob es sich dabei um ein von der Community entwickeltes Open Source-Tool handelt oder um eine für einen Kunden geschriebene Software. Eine API-Dokumentation erleichtert es Entwicklern, neu ins Projekt einzusteigen oder sich einen Überblick über alle relevanten Teile des Projekts zu verschaffen.

Ein weiterer Vorteil von API-Dokumentationen ist, dass sie sich schnell und automatisch generieren lassen. Dieser Schritt kann in den Build-Prozess integriert werden, so dass immer eine aktuelle, ggf. auch versionierte Dokumentation vorliegt. Sie sind sozusagen der leicht erfüllbare Mindeststandard für eine Dokumentation.

Denn, seien wir ehrlich, eine API-Dokumentation erklärt und veranschaulicht nicht (das machen Codebeispiele und handgeschriebene Dokumentationen), sondern ist eher eine Art Nachschlagewerk. Durch die immer besseren Funktionalitäten von IDEs verliert es sogar mittlerweile an Bedeutung. Ich persönlich schaue nur selten in einer API-Dokumentation nach, wenn ich das Projekt schon in meiner Entwicklungsumgebung vorliegen habe. Your mileage may vary

"API-Dokumentationen mit ApiGen erstellen" vollständig lesen

Gestern durfte ich beim Stammtisch der Google Developer Group Rhein-Main einen Einführungs-Vortrag zu Ingress halten. Das Treffen fand im schönen neuen Frankfurter Coworking-Space Die Zentrale mitten in Bornheim statt.

Die Slides zu meinem Vortrag habe ich hier online gestellt. Vielen Dank an Jochen für die Einladung und an alle Teilnehmer fürs mitdiskutieren. Der Abend hat mir sehr viel Spaß gemacht!

2013 wird uns in Erinnerung bleiben als das Jahr, in dem die Newsletter zurückkehrten. Und zwar, um das hier klarzustellen, nachdem ich es auf Twitter nicht deutlich genug in 140 Zeichen unterbrachte, meine ich nicht die oft unerwünschten Newsletter von Online-Shops und ähnliche „klassische“ E-Mail-Marketing-Maßnahmen. Die einen lassen diese unmittelbar vom Mailprogramm ausfiltern, die anderen finden sie nützlich, weil sie auf Schnäppchen und Neuigkeiten aus sind. Nein, ich meine Newsletter von Einzelpersonen, z.B. Bloggern, und zu klar umrissenen Themenbereichen!

Bisher galt: Wenn ich über Blogbeiträge meiner Lieblingsblogs auf dem Laufenden bleiben möchte, abonniere ich deren RSS-Feed. Möchte ich mich zu einem Thema mit anderen Interessierten austauschen, beteilige ich mich auf einer Mailingliste¹. Nun aber scheinen viele Rezipienten unter einer Art information overflow zu leiden und mit dem nie abreißenden Informationsfluss auf Twitter, Facebook, Google+ und im Feed-Reader nicht mehr klarzukommen. Der Filter im Kopf ist überlastet, Filter in der Software funktionieren schlecht oder sind nicht vorhanden.

"Die Rückkehr der Newsletter" vollständig lesen

Am Dienstag, dem 22. Januar 2013, fand das 22. Treffen der PHPUG Rheinhessen bei netz98 in Mainz statt. Neben dem „harten Kern“ konnten wir auch wieder einige neue Gesichter begrüßen, was uns immer ganz besonders freut.

Peter Eulberg präsentierte uns eine angepasste Version seines Webinars „Die effektive Website - vom Bedarf zum Erfolg“ und zeigte am Beispiel von WordPress, welche Aspekte auch schon bei kleineren Webseiten beachtet werden sollten und wie Kunden gezielt beraten werden können.

Zuvor hatte ich kurz vorgestellt, was man sich unter einer Code Kata vorzustellen hat und wozu diese gut ist. Das Konzept hatte ich über die Softwerkskammer Rhein-Main kennengelernt, und ich wollte ausprobieren, ob es sich im Rahmen der PHPUG einsetzen lässt. Also habe ich die Roman Numerals Kata als Guided Kata am Beamer durchgeführt und dabei viel Interessantes gelernt. Wir kamen auf eine Lösung, die ich so für mich noch nicht erarbeitet hatte. Und ich stellte fest, dass die vielen kleinen Schritte (baby steps) einer Kata wichtig sind, auch wenn sie auf den ersten Blick nerven. Das Format hat mir jedenfalls viel Spaß gemacht. Ich denke, wir sollten das bei Gelegenheit wiederholen.

"22. Treffen der PHPUG Rheinhessen" vollständig lesen

Ich lese allerorten, dass 2013 das Jahr wird, in dem Blogs wieder an Bedeutung gewinnen. Dabei bin ich mir gar nicht sicher, ob Blogs in den letzten Jahren tatsächlich so viel an Stellenwert eingebüßt haben. Blogs haben sich gewandelt, ja. Heute können Blogs große gesellschaftliche Debatten anstoßen, eine Macht, die ihnen vor nicht allzu langer Zeit noch abgesprochen wurde. Zumindest aber sind sie wichtige Teile vieler Diskurse zu so gut wie jedem Thema, das vorstellbar ist. Da kann selbst die traditionelle Special Interest-Presse nicht mithalten.

Ein eigenes Blog (neudeutsch: einen eigenen Blog) zu haben, bedeutet auch, Teil dieser Diskurse sein zu können, selbst wenn eine Angelegenheit noch so unbedeutend erscheinen mag. Manchmal bedeutet es auch, eine Last mit sich herumzuschleppen, wenn die Lust zu schreiben mal fehlt oder scheinbar niemand das Geschriebene liest. Die Schwelle zwischen Last und Lust ist manchmal so schmal wie ein Vokal. Ein Blog ist aber eben nur eine Möglichkeit, keine Pflicht. So empfinde ich das jedenfalls: Meine Blogs sollen mir und denen, die es lesen, Freude bereiten. So wie Menschen Freude empfinden, wenn sie Maradona oder Messi Fußball spielen sehen.

Diese Freude potenziert sich mit jedem Kommentar, Tweet, Like, Flattr, Trackback oder Plus, den ein Blogbeitrag erhält.¹ Die Anerkennung und das Wissen, dass „da draußen” Menschen sind, die das Blog mit Freude lesen, die im besten Fall sogar einen Gewinn für sich daraus ziehen: unbezahlbar.

Ich bin weder Maradona noch Messi, freue mich aber, dass ich zehn Jahre Sperrobjekt Weblog „durchgehalten” habe, und werde voraussichtlich auch mit Freude weiterbloggen. Ob ich noch einmal zehn oder mehr Jahre schaffe? Wir werden sehen …

¹Wink mit dem Zaunpfahl