Hilfsmittel/Dokumentationen

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche

[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.

Meine Werkzeuge
Namensräume

Varianten
Aktionen
Übersicht
Hilfe
SELFHTML
Diverses
Werkzeuge
Flattr
Soziale Netzwerke