Was wir schreiben

In diesem Abschnitt werden die von den Mozilla MDN-Mitarbeitern festgelegten Richtlinien beschrieben, die den Inhalt auf den MDN Web Docs regeln. Alle Mitwirkenden an den MDN Web Docs müssen diese Richtlinien einhalten.

Alle Inhalte auf den MDN Web Docs müssen für den Technologiebereich relevant sein, in dem sie erscheinen. Spam (kommerzielle Werbung) und andere irrelevante Inhalte werden auf der Website niemals akzeptiert. Mitwirkende, die immer wieder versuchen, Spam einzureichen, können nach Ermessen der Mozilla MDN-Mitarbeiter von MDN ausgeschlossen werden.

Ausgehende Links zu kommerziellen Seiten, die für das Thema, von dem sie verlinkt werden, relevant sind, werden von Fall zu Fall bewertet. Ihr Wert bei der Unterstützung von Webentwicklern muss den kommerziellen Vorteil für die verlinkte Seite überwiegen.

Artikel auf den MDN Web Docs müssen einen neutralen Standpunkt wahren und ohne redaktionelle Voreingenommenheit über Browserunterschiede berichten. Abfällige Kommentare über einen Browser oder Benutzeragenten sind nicht akzeptabel.

Webtechnologien, die auf den MDN Web Docs dokumentiert werden sollen, sollten sich auf einem Standardisierungspfad befinden und müssen von mindestens einer Rendering-Engine implementiert sein. Unterschiede in der Browserunterstützung werden im Abschnitt über die Browser-Kompatibilität eines Artikels dokumentiert.

Wenn Sie Inhalte für die MDN Web Docs vorschlagen möchten, lesen Sie bitte diese Seite, bevor Sie einen Vorschlag einreichen, um sicherzustellen, dass das, was Sie vorschlagen, angemessen ist.

Für neue Referenzseiten oder Leitfäden öffnen Sie bitte ein neues Issue, in dem Sie darlegen, welche Inhalte Sie vorschlagen und warum (bitte seien Sie so ausdrücklich wie möglich).

Für Vorschläge zu größeren Projekten, die neue Inhaltsabschnitte beinhalten, beachten Sie bitte die Seite zu den Kriterien für die Aufnahme, die auch den Bewerbungsprozess beschreibt.

Im Allgemeinen dokumentieren wir auf den MDN Web Docs Open-Web-Technologien. Dazu gehört jede Funktion, die von Webentwicklern zum Erstellen von Websites und Anwendungen jetzt und in naher Zukunft genutzt werden kann.

Wenn eine Funktion von mehreren Browsern implementiert und entweder als Standard akzeptiert oder zur Standardisierung vorangetrieben wird, dann dokumentieren wir sie auf jeden Fall hier. Wenn eine Funktion noch sehr experimentell ist und nicht in mehreren Browsern implementiert und/oder Änderungen unterworfen ist, kann sie immer noch für die Aufnahme geeignet sein, wird aber möglicherweise nicht als Priorität für das Redaktionsteam angesehen.

Mit anderen Worten sollten Webtechnologien, die auf den MDN Web Docs dokumentiert werden, alle folgenden Kriterien erfüllen:

• Auf einem Standardisierungspfad sein.
• In einer Spezifikation einer zuverlässigen Standardisierungsorganisation spezifiziert sein.
• Von mindestens einer Rendering-Engine implementiert sein.
• In einer stabilen Browserversion veröffentlicht sein.

Unser Hauptaugenmerk liegt darauf, über die folgenden Front-End-Webtechnologien zu schreiben:

• HTML
• CSS
• JavaScript
• Web APIs
• HTTP

Wir dokumentieren auch einige breitere Themen, wie SVG, XML, WebAssembly und Barrierefreiheit. Darüber hinaus bieten wir umfangreiche Lernleitfäden für diese Technologien und auch ein Glossar an.

Alle Inhalte auf den MDN Web Docs müssen für den Technologiebereich relevant sein, in dem sie erscheinen. Die Mitwirkenden werden erwartet, diese MDN-Schreibrichtlinien für Schreibstil, Codebeispiele und andere Themen zu befolgen.

Für weitere Details über die Kriterien, ob eine Technologie auf den MDN Web Docs dokumentiert werden kann, lesen Sie die Seite zu den Kriterien für die Aufnahme.

Auf den MDN Web Docs sind wir ständig bestrebt, neue Webstandardtechnologien zu dokumentieren, sofern angemessen. Wir versuchen, einen Ausgleich zu finden zwischen der Bereitstellung der Dokumentation früh genug, damit Entwickler über neue Funktionen lernen können, sobald sie sie benötigen, und der Bereitstellung spät genug, damit die Technologie ausgereift und stabil ist, sodass die Dokumentation nicht ständig aktualisiert oder schnell entfernt werden muss.

Im Allgemeinen besteht unsere Definition des frühesten Zeitpunkts, wann wir in Erwägung ziehen, eine neue Technologie zu dokumentieren, darin: Wenn die Funktion auf einem Standardisierungspfad ist und irgendwo implementiert wird.

Wir erwägen die Dokumentation einer neuen Technologie, wenn sie:

• In einem Spezifikationsdokument spezifiziert ist, das unter einer verlässlichen Standardisierungsorganisation (wie W3C, WHATWG, Khronos, IETF, etc.) veröffentlicht wurde und ein angemessenes Stabilitätsniveau erreicht hat (z.B. ein W3C-Arbeitsentwurf oder ein Kandidatenempfehlung oder wenn die Spezifikation stabil aussieht, gemessen an den eingereichten Issues), und
• Konsistent in mindestens einem Browser implementiert wurde, wobei andere Browserentwickler Anzeichen von Interesse zeigen (wie ein aktives Ticket oder ein "Implementierungsabsicht"-Prozess in Kraft ist).

Wir dokumentieren eine neue Technologie nicht, wenn:

• Sie keine Spezifikation hat oder die Spezifikation ein grober Entwurf ist, der zu Änderungen neigt,
• Ein oder null Browser sie derzeit implementiert haben und Browser, die sie nicht unterstützen, keine Anzeichen von Interesse an der Implementierung zeigen. Dies kann man abschätzen, indem man Ingenieure fragt, die an diesen Browsern arbeiten, und indem man Browser-Bug-Tracker und Mailinglisten betrachtet, etc.,
• Es sich um keine webexponierte Technologie handelt und/oder sie komplett proprietär ist, oder
• Sie bereits Anzeichen dafür zeigt, dass sie veraltet ist oder durch eine ähnliche Funktion ersetzt wird.

Im Allgemeinen gehört alles, was kein Open-Web-Standard ist, nicht auf die MDN Web Docs. Spam (kommerzielle Werbung) und andere irrelevante Inhalte werden niemals auf der Website akzeptiert. Mitwirkende, die immer wieder versuchen, Spam einzureichen, können nach Ermessen der Mozilla MDN-Mitarbeiter von MDN ausgeschlossen werden.

Beispiele für unangemessene Themen für die MDN Web Docs sind:

• Technologie, die nicht im Web exponiert wird und/oder spezifisch für einen Browser ist.
• Technologie, die nicht mit dem Web zusammenhängt.
• Dokumentation für Endnutzer. Für Mozilla-Produkte gehört eine solche Dokumentation beispielsweise auf die Mozilla-Support-Website.
• Selbstverlinkende oder selbstpromovierende externe Links. Überprüfen Sie diese Richtlinien in unserem Schreibstil-Leitfaden bevor Sie einen externen Link hinzufügen.

Seiten werden von den MDN Web Docs gelöscht, wenn sie keine nützlichen Informationen mehr enthalten, ausreichend veraltet sind und/oder so ungenau sein könnten, dass es irreführend wäre, sie weiterhin zu veröffentlichen.

Die folgenden Beispiele beschreiben Situationen, in denen Seiten/Inhalte gelöscht werden könnten:

• Artikel enthalten Informationen über Funktionen, die nicht in allen Browsern implementiert wurden und später zurückgezogen wurden (normalerweise experimentelle Funktionen wie prefixed Funktionalität).
• Referenzseiten beschreiben Funktionen, die aus der Spezifikation entfernt wurden, bevor sie in einem Browser implementiert wurden.
• Artikel decken Techniken ab, die später als schlechte Praktiken erwiesen und durch bessere Techniken ersetzt wurden.
• Artikel enthalten Informationen, die später durch andere, qualitativ bessere Artikel ersetzt wurden.
• Artikel enthalten Inhalte, die für die MDN Web Docs unangemessen sind.
• Bereiche der MDN Web Docs konzentrieren sich nicht auf Open-Web-Technologien und sind eine Wartungslast.

Für weitere Informationen darüber, wie Dokumente gelöscht werden, lesen Sie bitte den Leitfaden zum Erstellen, Verschieben und Löschen von Seiten.

Im Allgemeinen fällt unsere Dokumentation in die folgenden Kategorien:

• Referenz
• Leitfaden
• Glossar
• Lernen/Tutorials

Im Allgemeinen sind die MDN Web Docs für Produkt-Dokumentation gedacht, nicht für Projekt- oder Prozess-Dokumentation. Wenn das Dokument also darüber ist, "wie man ein Ding benutzt" oder "wie ein Ding funktioniert" (wobei das "Ding" in einer der oben genannten Themenkategorien liegt), dann kann es auf den MDN Web Docs platziert werden.

Wenn ein Dokument darüber handelt, "wer an der Entwicklung eines Dings arbeitet" oder "Pläne für die Entwicklung eines Dings", dann sollte es nicht auf den MDN Web Docs platziert werden.

Hier sind einige Beispiele für Dokumenttypen, die nicht auf den MDN Web Docs platziert werden sollten:

• Planungsdokumente
• Entwurfsdokumente
• Projektvorschläge
• Spezifikationen oder Standards
• Werbematerialien, Werbung oder persönliche Informationen