Grundlagen/Hilfsmittel/Dokumentationen

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche

Inhaltsverzeichnis

[Bearbeiten] Allgemeines zu Dokumenten und Dokumentationen

Die Fülle der Techniken und Technologien, die im Web und im Internet allgemein kursieren und eingesetzt werden, ist gewaltiggewaltig und permanent in Entwicklung. Kein Mensch ist in der Lage, alles, was dazugehört, zu kennen und zu beherrschen. Es ist deshalb essentiell wichtig, dass alle eingesetzten Techniken und Technologien möglichst gut und vollständig dokumentiert sind, und dass diese Dokumentationen offen zugänglich und einsehbar sind. Technische Dokumentation ist im Internet das Salz der Erde. Ohne Dokumentation gäbe es kein Internet - denn die Techniken und Technologien allein würden an die Köpfe derer gebunden bleiben, die sie beherrschen, sich nicht verbreiten und schnell in Vergessenheit geraten. Dokumentation ist also die Schriftkultur des Internet und die Basis für die Stabilität des Internet. Die meisten Menschen, die sich wirklich tiefer auf das Internet einlassen, begreifen das auch früher oder später. In den Jahrzehnten, die das Netz nun schon an Erfahrung gewinnen konnte, haben sich gewisse Standards beim Dokumentieren etabliert. Das betrifft sowohl die Art und Weise der Beschreibungen, als auch den Verbindlichkeits-Charakter.


Als Entwickler von Web-Seiten werden Sie kaum mit einer Dokumentation wie der vorliegenden alleine auskommen, auch wenn diese noch so umfangreich und ausführlich erscheinen mag. Denn es gibt einerseits Dokumente, die spezielle Themen einfach vollständig behandeln, was im Rahmen einer übergreifenden Dokumentation wie der vorliegenden niemals möglich ist. Und andererseits gibt es Dokumente, die einen höheren Verbindlichkeits-Charakter haben als die Dokumentation, die Sie hier lesen. Denn nicht, was hier steht, ist beispielsweise der Maßstab dafür, wie HTML auszusehen hat, sondern das, was in demden dafür vorgesehenen offiziellen Dokumenten des W3-Konsortiums steht. Die verschiedenen Dokumentationsformen haben alle ihren Zweck und ihre Daseinsberechtigung. Aber Sie sollten die Unterschiede kennen und wissen, welche Dokumentationsform welche Aufgaben hat. Und schließlich müssen Sie natürlich auch wissen, wie Sie an die entsprechenden Dokumente herankommen.

Praktisch alle wichtigen Dokumente im Internet liegen in englischer Sprache vor. Viele davon sind auch nicht in Übersetzungen verfügbar, und wenn, dann gelten die englischsprachigen Versionen als die normative Grundlage. Der Einsatz automatischer Übersetzungshilfen führt bei solchen Texten in der Regel zu erheiternden Momenten, hilft aber beim Verständnis der Texte kaum weiter. Gute Kenntnisse der englischen Sprache sind also eine wichtige Voraussetzung, um die Originaldokumente lesen zu können.

[Bearbeiten] Recommendations des W3-Konsortiums

Das W3-Konsortium ist ein unabhängiges, sich selber überwachendes Gremium für die technischen Standards im Web. Recommendations (Empfehlungen) des W3-Konsortiums sind Dokumente mit dem höchsten im Web verfügbaren Verbindlichkeits-Charakter. Es handelt sich um technische Beschreibungen einzelner Web-Technologien wie beispielsweise Seite HTML, Seite CSS oder Seite XML. Die Recommendations haben die Aufgabe, die jeweilige Technologie vollständig und unmissverständlich darzustellen. Die Zielgruppen dieser Beschreibungen sind einerseits Web-Autoren, aber auch Software-Hersteller, z.B. von Web-Browsern, die angehalten sind, diese Standards so genau und vollständig wie möglich in ihren Produkten zu implementieren. Der Anspruch der Exaktheit und Vollständigkeit macht die Recommendations für Anfänger nicht unbedingt zu einer leichten Lektüre. Denn nicht selten leidet die Allgemeinverständlichkeit unter den Zwängen der Terminologie. Das W3-Konsortium ist sich aber bewusst, dass diese Dokumente zum Teil auch von weniger spezialisierten Leuten und Nicht-Informatikern gelesen werden oder gelesen werden müssen. Die neueren Recommendations sind daher reichhaltiger erläuternd als die früheren. Auch mit erhellenden Beispielen wird nicht mehr so gespart.

Jede Recommendation durchläuft ein längeres Verfahren, in dessen Verlauf das Dokument mehrmals von verschiedenen Seiten gereviewt wird. Aus losen technischen Notizen entstehen zunächst Working Drafts (Arbeitsentwürfe), von denen es eine oder mehrere geben kann. Arbeitsentwürfe lassen das geplante End-Dokument bereits gut erkennen. Verbindlich sind sie jedoch noch nicht. Nach diversen Reviews innerhalb der Arbeitsgruppe und nach Abstimmung mit der Interessengruppe erlangt das Dokument schließlich den Status einer Candidate Recommendation (Empfehlungskandidat). In diesem Stadium wird noch Feedback aus der Öffentlichkeit erwartet und gegebenenfalls eingearbeitet. Daraus entsteht die Proposed Recommendation (Empfehlungsvorschlag). Nach einem abschließenden Review erhält das Dokument schließlich den Status einer offiziellen Recommendation.

Die Entwicklung der jeweiligen Technologie ist damit natürlich nicht abgeschlossen. Es handelt sich lediglich um festgeschriebene Entwicklungsstadien, damit Entwickler Fixpunkte haben, an die sie sich halten können. Die Recommendations erhalten aus diesem Grund Versionsnummern, ähnlich wie bei Software-Produkten üblich. So gibt es beispielsweise HTML 4.01, CSS2 oder XML 1.0. Für neue Dokumentversionen wird das Review-Verfahren ganz oder teilweise wiederholt.


Sämtliche Recommendations des W3-Konsortiums, auch in ihren vorausgehenden Review-Stufen, sind über folgende Web-Adresse erreichbar:

(englischsprachige Seite) http://www.w3.org/TR/

Das "TR" steht dabei für Technical Reports (technische Berichte). Sämtliche Dokumente werden in englischer Sprache veröffentlicht, und die englischsprachige Version ist die normative Version. Viele der Dokumente sind aber auch bereits in andere Sprachen übersetzt worden, auch ins Deutsche. Über die folgende Adresse können Sie verfügbare Übersetzungen aufrufen:

(englischsprachige Seite) http://www.w3.org/Consortium/Translation/

Alle wichtigen Recommendations des W3-Konsortiums liegen im HTML-Format vor und können von den Web-Seiten des W3-Konsortiums in gezippter Form heruntergeladen werden. Auf diese Weise kann sich jeder Web-Entwickler lokale Kopien derjenigen Dokumente besorgen, die er für seine tägliche Arbeit benötigt. Wenn Sie sich ernsthaft mit HTML, CSS, XML usw. beschäftigen wollen, ist es dringend zu empfehlen, sich diese Dokumente zu besorgen und sich damit zu beschäftigen.

[Bearbeiten] Requests For Comments (RFCs)

Während die Recommendations des W3-Konsortiums speziell für das World Wide Web gelten, gibt es auch Dokumente für technische Standards im Internet allgemein. Das Verfahren für diese Standards ist nicht ganz so straff organisiert wie es durch die Organisation des W3-Konsortiums möglich ist. Doch das Verfahren hat sich bewährt, und die Dokumente gelten für Entwickler als verbindliche Grundlagen.

[Bearbeiten] Organisation und Verwaltung

Die Requests for Comments (RFCs) (wörtlich: "Antrag auf Kommentierung") sind der Dokumenttyp für solche Beschreibungen. Die Sammlung der RFCs wird seit den Anfangstagen des ARPANET, also seit 1969, geführt. Neue RFCs erhalten fortlaufende Nummern. So entstehen Dokumentnamen wie RFC 959 oder RFC 1867. Einer der RFCs, der RFC mit der Nummer 1543, beschreibt, wie RFCs auszusehen haben. Denn nur wenn ein einheitliches Schema eingehalten wird, ist sichergestellt, dass die RFCs eine gleichbleibende Qualität haben. Verwaltet werden die RFCs heute von der Organisation englischsprachige Seite Internet Engineering Task Force (IETF) und dem (englischsprachige Seite) RFC-Editor.

Jeder Internet-Teilnehmer kann zu neuen RFCs beitragen. Wer einen neuen Standard vorschlagen möchte, z.B. ein bestimmtes Dateiformat oder ein bestimmtes technisches Ablaufverfahren, der kann einen so genannten Internet Draft (Internet-Entwurf) verfassen. Dabei hält er sich bereits an die im RFC 1543 festgelegten Regeln, wie die Beschreibung auszusehen hat. Den fertigen Internet-Draft reicht er bei der IETF-Organisation ein. Dort gibt es eine Mailing-Liste, die alle an technischen Standards interessierten Internet-Teilnehmer abonnieren können. Neue Internet-Drafts werden in dieser Mailing-Liste bekannt gemacht und können diskutiert werden. Aus den Diskussionen ergeben sich in der Regel noch Korrekturen, Verbesserungsvorschläge usw., die der Verfasser des Internet Drafts in sein Dokument einbringt. Nach einer angemessenen Diskussionsphase entscheidet schließlich die IETF-Organisation darüber, ob das Dokument ein offizieller RFC wird. Wenn ja, erhält es eine RFC-Nummer und wird in die Sammlung der RFCs aufgenommen.

RFCs enthalten viel Wissen, mitunter aber auch persönliche Ansichten der Autoren oder humorvolle Passagen. Viele wichtige Defacto-Standards im Internet, etwa das HTTP-Protokoll oder die MIME-Technik für E-Mails, liegen in Gestalt einer oder mehrerer RFCs vor. Aus RFCs sind auch schon häufig Teile von W3C-Recommendations hervorgegangen. So liegen etwa den heute im HTML-Standard verankerten Elementen für Multimediaobjekte oder Tabellen ursprünglich RFCs zugrunde.

RFCs sind im Original reine Textdateien und durchgängig in englischer Sprache verfasst. Über die Web-Adresse englischsprachige Seite http://www.rfc-editor.org/rfc.html können Sie die aktuelle Sammlung der RFCs aufrufen.

Es ist sehr empfehlenswert, sich die Liste der RFCs mal in Ruhe anzusehen und einzelne RFCs daraus aufzurufen. Als Web-Entwickler sollten Sie den Dokumenttyp der RFCs kennen und wissen, dass in dieser Sammlung etliche Standards beschrieben sind, die Sie möglicherweise mal brauchen.

[Bearbeiten] Wichtige RFCs für das Webpublishing

URI/IRI
Uniform Resource Identifier (URI)
Internationalized Resource Identifiers (IRIs)
HTTP
Hypertext Transfer Protocol -- HTTP/1.1
HTTP Authentication: Basic and Digest Access Authentication
HTTP Over TLS (HTTPS)
MIME
Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies
Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types
Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text
Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures
SMTP und Mail-Relevantes
Simple Mail Transfer Protocol
Internet Message Format

[Bearbeiten] Frequently Asked Questions (FAQs)

Frequently Asked Questions (häufig gestellte Fragen) sind keine offiziellen Dokumente in dem Sinn, dass sie von einer Organisation herausgegeben und verwaltet werden. Es handelt sich einfach um einen Dokumentationstyp, der sich im Internet etabliert hat und eine lange Tradition hat. Es gibt FAQs zu allen nur erdenklichen Themen - von Tieren über Politik und Religion bis hin zu technischen Fragen zum Internet. Im Web gibt es unter der Domain (englischsprachige Seite) faqs.org eine Sammelstelle für FAQs. Es handelt sich dabei um eine Sammlung mit Verweisen zu FAQs.

FAQs basieren auf Fragen, die in Mailing-Listen, Newsgroups oder Foren - eben überall dort, wo Internet-Teilnehmer sich gegenseitig austauschen können - immer wieder auftauchen und gestellt werden. Eine beliebte Frage in Foren für Web-Seiten-Entwickler lautet beispielsweise: "Wie programmiere ich einen Passwortschutz für meine Seiten?". Anstatt eine Dokumentation zu schreiben, die sich inhaltlich in Kapitel, Themen, Unterthemen usw. aufgliedert, enthält eine FAQ als Unterüberschriften genau diese Fragen, als Frage formuliert. Unterhalb davon wird dann eine ordentliche und zielführende Antwort gegeben. In den Diskussionsbereichen, wo solche Fragen immer wieder auftauchen, können die "alten Hasen" dann, bevor sie nervlich explodieren, weil die gleiche Frage schon zum dritten Mal innerhalb von zwei Tagen gestellt wurde, einfach auf die FAQ verweisen. FAQs sind deshalb mittlerweile auch meistens im Web in Form von Web-Seiten verfügbar - denn das ist die bequemste Form, den Fragesteller direkt auf die Antwort zu seiner Frage zu verweisen.

Gerade wenn Sie im Netz auf der Suche nach Support sind und sich noch nicht sonderlich auskennen, sollten Sie auf jeden Fall folgsam sein, wenn man Sie auf eine FAQ verweist. Denn FAQs sind aus der Praxis entstanden und tragen dazu bei, dass sich Hilfestellungen auf Probleme konzentrieren können, die nicht so alltäglich sind.

[Bearbeiten] Anbieter-Dokumentationen

Alle Kapitel Web-Technologien, die nicht vom W3-Konsortium standardisiert werden, sind trotzdem irgendwo "im Original" dokumentiert. Denn hinter solchen Technologien, sei es nun Java, Perl, PHP usw., stecken Anbieter, die ein Interesse an der Verbreitung ihrer Technologie haben. Verbreiten kann sich eine Technologie aber nur, wenn sie ordentlich dokumentiert ist. Deshalb finden Sie normalerweise auf den Web-Seiten der Technologie-Anbieter die verbindlichen Dokumentationen für die jeweilige Technologie.

<-- Neue Überschrift (Strukturierung) -->

[Bearbeiten] Entwicklerseiten von Browser-Anbietern

Wichtig sind für Web-Entwickler auch die Entwicklerseiten der großen Browser-Anbieter. Die beiden folgenden Angebote sollte jeder, der sich mit dem Erstellen von Web-Seiten beschäftigt, kennen:


Entwicklerseiten von Microsoft (englischsprachige Seite)
Dort finden Sie beispielsweise die Original-Dokumentationen zu JScript, der Microsoft-Implementierung von JavaScript. Ein wenig suchen müssen Sie allerdings, denn dort werden auch andere Technologien beschrieben, die nichts mit Web-Entwicklung zu tun haben. Der Informationsbestand ist gewaltig.
Entwicklerseite von Mozilla (englischsprachige Seite)
Mozilla entwickelt die in vielen Browsern vorhandene Gecko-Rendering Engine und ist zudem oft wichtig für die Dokumentation von Javascript-Neuerungen, die (noch) nicht im ECMA-Standard integriert sind.
Entwicklerseite von Safari (englischsprachige Seite)
Safari ist in einigen Gebieten Vorreiter in der Implementation von neuen CSS-Vorschlägen.
Entwicklerseite von Opera (englischsprachige Seite)
Opera ist vor allem für Mobiles ein wichtiger Browser.


[Bearbeiten] Original-Dokumentation wichtiger Serverseitiger Technologien

PHP
Die verbreitetste Scripting Sprache für Server: PHP Manual Deutsche Ansicht der PHP-Dokumentation
Perl
Die Sprache mit einer langen soliden Entwicklung und riesigem Modul-Archiv:

perldoc.org (Englisch) dokumentiert den Sprachkern von Perl.

Perl-CPAN
Das Comprehensive Perl Archive Network http://www.cpan.org/ macht Perl-Module weltweit verfügbar. Perl-Module beinhalten ihre eigene Dokumentation.
Ruby
Ruby ist eine neuere Sprache, optimiert für schnelle Webentwicklung: http://www.ruby-lang.org/de/documentation/
RubyOnRails
Rails ist ein Framework für Ruby welches die Entwicklung nochmals beschleunigt. http://rubyonrails.org/documentation

[Bearbeiten] Freie Dokumentationen

Freie Dokumentationen sind solche wie die, die Sie gerade lesen. Solche Dokumentationen können von jedem Autor, der sich dazu bemüßigt fühlt, im Netz veröffentlicht werden. Es gibt jedoch keinerlei kontrollierende Instanz dafür, und deshalb gibt es auch keine Garantie dafür, wie vollständig und sachlich richtig solche Beschreibungen sind. In der Regel entscheidet allerdings die Netzgemeinde über den Wert solcher Dokumentationen. Gute Dokumentationen werden von vielen anderen Web-Seiten aus verlinkt, werden dadurch immer bekannter und erreichen auf diese Weise den Status einer anerkannt brauchbaren Informationsquelle.

Eine wichtige Aufgabe der freien Dokumentationen ist es vor allem, das Wissen über Technologien in die einzelnen Landessprachen zu tragen. Denn gerade Anfänger tun sich nun mal leichter damit, eine neue, komplizierte Materie erst mal in der eigenen Sprache vermittelt zu bekommen. Und Menschen, die des Englischen nicht oder kaum mächtig sind, haben gar keine andere Wahl, als das Wissen über vermittelnde Quellen der eigenen Sprache zu erwerben.

Im Link-Verzeichnis des Online-Angebots von SELFHTML aktuell finden Sie aktuelle Verweise auf freie Dokumentationen in folgenden Seiten:

SELFHTML-Linkverzeichnis: HTML/XHTML SELFHTML-Linkverzeichnis: CSS Stylesheets SELFHTML-Linkverzeichnis: XML, DTDs und XSL(T) SELFHTML-Linkverzeichnis: JavaScript und DOM SELFHTML-Linkverzeichnis: Dynamisches HTML (DHTML) SELFHTML-Linkverzeichnis: CGI/Perl SELFHTML-Linkverzeichnis: PHP SELFHTML-Linkverzeichnis: ASP/.Net-Sprachen SELFHTML-Linkverzeichnis: Java


[Bearbeiten] Bücher

Wenn Sie die EDV-Fachabteilung einer Großstadt-Buchhandlung betreten, können Sie so viele Bücher rund um Themen zum Entwickeln von Web-Seiten mit nach Hause nehmen, dass Sie mehrere Regalwände damit füllen können. Vorausgesetzt, der Geldbeutel lässt es zu, denn preiswert sind solche Fachbücher fast nie. Dafür sind viele dieser Bücher schlecht. Aber nicht alle, manche sind auch hervorragend. Der Grund, warum es so viele schlechte Computer-Fachbücher gibt, liegt darin, dass es einerseits einen riesigen Lesermarkt für diese Fachliteratur gibt, aber nicht genügend Autoren mit echtem "Tiefenwissen". Es gibt zwar jede Menge gute Programmierer und Fachleute mit dem nötigen Wissen, doch die sind meistens mit Projekten ausgelastet und auch oft nicht in der Lage, ein Buch zu schreiben. Also suchen die EDV-Verlage, den großen Absatzmarkt im Auge, oft händeringend nach Autoren und gehen dabei nicht selten das Risiko ein, einen Titel zu produzieren, bei dem die Qualität zu kurz kommt. Meistens haben die Autoren auch nicht mehr als zwei, drei Monate Zeit, um Bücher von mehreren hundert Seiten aus dem Boden zu stampfen. Das verleitet natürlich dazu, woanders abzukupfern, ohne den Stoff wirklich zu durchdringen, Inhalte mit "Füllmaterial" zu strecken, uneinheitliche Terminologie zu verwenden usw. - vor allem dann, wenn der Autor nicht aus einem vorhandenen Praxiswissen schöpfen kann, sondern sich während der Erstellungsphase die Materie selber erst erarbeiten muss. Viele Bücher werden auch für den "schnellen Markt" produziert, d.h. sie werden ein paar Monate vom Verlag lang stark beworben, und dann verschwinden sie wieder, weil die Kalkulation des Verlags aufgegangen ist und ein weiteres Bewerben zu aufwendig wäre.

Bevor Sie sich Fachbücher anschaffen, sollten Sie daher nach Rezensionen suchen. Ganz hervorragend dazu geeignet sind die großen Internet-Buchanbieter wie deutschsprachige Amazon . Auch wenn Sie lieber in einer realen Buchhandlung kaufen, lohnt es sich, dort Vorab-Informationen einzuholen. Denn Leser können dort zu Büchern, die sie gelesen haben, Rezensionen schreiben. Bei vielen Büchern kommen auf diese Weise mehrere Rezensionen zusammen, die sehr authentisch sind, weil sie unmittelbare Erfahrungen von Lesern widerspiegeln. Suchen Sie einfach nach Büchern zu einem gewünschten Thema, z.B. zu Büchern über HTML oder Perl, und lesen Sie, was andere darüber zu berichten wissen. Das ist zumindest sinnvoller, als sich nur von den Klappentexten der Bücher leiten zu lassen.

Generell lässt sich sagen, dass Fachbücher umso besser werden, je ausgereifter eine Technologie ist. Wenn neue, von der Fachszene als bedeutsam eingeschätzte Technologien entstehen, wie es in den letzten Jahren beispielsweise bei Java oder XML der Fall war, dann überstürzen sich viele Verlage geradezu, um bei den ersten zu sein, die etwas zu dem betreffenden Thema publizieren. Was dabei herauskommt, ist aber fast immer mangelhaft, da die Technologien meist selber noch nicht ordentlich dokumentiert und noch in Entwicklung begriffen sind. In solchen Phasen ist es allemal besser, sich an kostenlose Dokumente im Internet zu halten. Ist eine Technologie dagegen gut eingeführt und etabliert, wie es mittlerweile etwa bei HTML der Fall ist, dann gibt es in der Regel auch ausgereifte Fachbücher dazu.

Meine Werkzeuge
Namensräume

Varianten
Aktionen
Übersicht
Hilfe
SELFHTML
Diverses
Werkzeuge
Flattr
Soziale Netzwerke