Previous Entry Share Next Entry
Perl 6 Tablets
kephra_lk
ich hab so paar Themen an denen ich jahrelang rumkaue denn Ausdauer ist gut. neben Kephra sind es die Perl 6 Tafeln die aus ein paar Wikiseiten der perl-community.de Wiki entstanden und jetzt vielleicht sogar zur offiziellen Perl 6 Nutzerdokumentation werden könnten. Genau, dieser Beitrag wird sowas wie die deutsche Übersetzung meines englischen Blogs für Leute welche die Meldung und manche meiner Twitternachrichten neugierig gemacht haben.

Die kurze Fassung war das die Tafeln nach http://tablets.perl6.org/ umgezogen sind. Die einprägsame URL und die schönere Gestaltung per CSS sind angenehmer für den Nutzer aber nicht der Hauptgrund warum ich das ganze für wichtig halte. Klar mache ich hier nichts weiter als meine Arbeit zu promoten aber es geht auch um was anderes.

1. Das Format

Die docs sind jetzt in markdown geschrieben was erstmal mir weit weniger schmerzen bereitet zu schreiben als die Socialtext Wikisyntax. Es fehlen einige funktionen wie unsichtbare Anker, aber man kann ja raw HTML einfügen. Per pandoc lassen sich auch sofort andere Formate erstelle wie PDF, HTML, POD oder epub.

2. Zusammenarbeit

Ursprünglich wählte ich ja wiki damit jeder mitmachen kann. Praktisch taten das sehr wenige. Aber seit die Tafeln im gleichen Archiv wie viele andere wichtige Perl 6-Sachen liegen machen weit mehr Leute mit. Und das obwohl das clonen und comitten in git ein wenig mehr Aufwand ist. Aber github macht es einfach (kleine Änderungen lassen sich sogar im editor-widget im browser tätigen) und commit bits werden freizügig erteilt. Jede Änderung schreibt der chatbot sofort in den im #perl6 channel per (was ich immer wollte). Rakudo, niecza, testsuite, specs, etc machen es genauso weil es Rückkopplung an die Alteingesessenen und lurker erleichtert und Fehler so schneller erkannt werden. Docs, Tests, Implementationen und Module können sich so gegenseitig zur besten Lösung hochschaukeln und Perl 6 wird dadurch wirklich zu einem MMORPG wie mäsak einst richtig schrieb.

3. Das Format

Es ist nicht nur die Syntax, sondern auch die Hypertext-Struktur der Doks die wir ja nicht so in der Kerndokumentation haben. Das ist auch gut so weil weiterhin viel im Terminal o.ä. gelesen wird. Aber weit wir den Mehrwert des Lesens und Lernens a la Wikipedia kennen, sollten wir es auch nutzen. Und ich versuch explizit es so zu schreiben das die Tafeln auch noch funktionieren wenn alle Links rausformatiert werden. Dennoch glaub ich das der nutzen ein wesentlich größer ist wenn es so abläuft: Wenn ein Neuling oder Aussenseiter eine Frage hat, welche die FAQ gut beantwortet nur er versteht darin ein Wort nicht dann kann er mit einem Klick in den Glossar gehen wo es erklärt wird und von dort gleich zu den Beispielen wo es angewandt wird oder er sieht mit welchen syntaktischen mitteln Perl das löst. Das hilft wesentlich Leute zu informieren was Perl ist und auch Vorurteile abzubauen.

Doch das in der Perl 5-Welt zu sehen ist noch reines Luftschloss, da nicht mal die ganzen Anhänge fertig sind geschweige die Tafeln selber. Anhang A, der Hauptindex aller Befehle ist schon umfangreich und gut gestaltet, in Anhang B findet sich vieles davon thematisch sortiert, Anhang D die Perldelta bietet einiges wesentliches, Anhang E - die Appetithappen auch. Derzeit bemühe ich mich vor allem G - den Glossar und F die FAQ zu vervollständigen. Mitarbeit ist natürlich ständig erwünscht und die deutsche Version musst wegen dieser Proportionen der Arbeit leider aufgegeben werden.

?

Log in