Dokumentationen können spannend sein

Manch eine Dokumentation liest sich in ihrer deutschen Übersetzung sehr spannend und steht einem abwechslungsreichen Abenteuerroman im nichts nach.
Ein sehr gutes Beispiel eines solchen "Bestsellers" ist die (Online-)Referenz des Zend Frameworks.

Nehmen wir da mal einige Textpassagen heraus...

Zitat:
Zend_Controller_Front implementiert ein Front Controller-Entwurfsmuster, das in Model-View-Controller (MVC)-Anwendungen verwendet wird. Seine Aufgabe ist, die Abfrage-Umgebung zu initialisieren und die eingehenden Abfragen zu routen ... Angenommen dass Zend_Filter_Input ein Käfig für externe Daten ist. Daten betreten die Anwendung von externen Quellen ... Daten werden zuerst in den Käfig gesperrt, und die Anwendung kann diese Daten nur dann Stück für Stück empfangen wenn dem Käfig gesagt wird, was diese Daten sein sollten und wie geplant ist diese zu verwenden. Der Käfig inspiziert die Daten ... mit Hilfe von Zend_Validate und Zend_Filter ... auf Gültigkeit ... Der Käfig entlässt die Daten nur wenn diese alle Notwendigkeiten komplett erfüllen. Mit einem einzigen und bequemen Interface, wird gutes Programmierverhalten ermöglicht und es lässt Entwickler darüber nachdenken wie die Daten verwendet werden.


Für den kleinen Rest der Welt, welcher nicht in Nullen und Einsern denkt, wäre dies ungefähr so zu verstehen...

Alle Pilger (Daten), die die heilige Stadt (Anwendung) betreten möchten, nehmen den einzig möglichen Weg durch das Haupttor (Front-Controller-Pattern) der vorderen Verteidigungseinrichtungen (Model-View-Controller). Alle Ankömmlinge werden zuallererst in einen verrosteten Eisenkäfig gesteckt (Zend_Filter_Input). Die verantwortlichen Aufseher prüfen die Papiere der Reisenden und durchwühlen das mitgeführte Gepäck (Validatoren). Darüber hinaus misshandeln sie bei Bedarf die Reisenden (Filter) - alles natürlich im Rahmen festgelegter Gesetze (Filter-Regeln). Alle Pilger, die diese erniedrigenden Prozeduren überstanden haben, bzw. sich den gültigen Gesetzen und ethnischen Idealvorgaben (Datentyp, Coding Guidlines) gebeugt haben, werden in das Heiligtum durchgelassen. Alle Rebellen, Märtyrer und unverbesserlichen Andersartigen, die sich der staatlichen Gewalt nicht beugen wollen, verrotten in diesem Käfig bis in alle Ewigkeit (Reset des Webservers). Nur der Stadtherr (Entwickler) alleine besitzt die Macht Entscheidungen zu treffen und über das Leben der Pilger (Daten) zu richten.

Kommentare
© 2000-2018 ganje.de