Schreibrichtlinien

MDN Web Docs ist ein Open-Source-Projekt. Die unten aufgeführten Abschnitte beschreiben unsere Richtlinien darüber, was wir dokumentieren und wie wir dies auf den MDN Web Docs tun. Um zu erfahren, wie Sie beitragen können, siehe unsere Beitragsrichtlinien.

Was wir schreiben

Dieser Abschnitt behandelt, was wir in die MDN Web Docs aufnehmen und was nicht, sowie eine Reihe anderer Richtlinien, wie wann wir über neue Technologien schreiben, den Vorschlagprozess für Inhalte und ob wir externe Links akzeptieren. Dies ist ein guter Ausgangspunkt, wenn Sie in Betracht ziehen, Inhalte für uns zu schreiben oder zu aktualisieren.

Aufnahmekriterien

Dieser Artikel beschreibt detailliert die Kriterien für Inhalte, die in die MDN Web Docs aufgenommen werden sollen, den Anwendungsprozess zum Hinzufügen neuer Dokumentationen sowie Erwartungen und Richtlinien für eine Partei, die sich bewirbt.

Unser Leitfaden für den Schreibstil

Der Leitfaden für den Schreibstil behandelt die Sprache und den Stil, den wir beim Schreiben auf den MDN Web Docs verwenden. Er behandelt auch, wie man Code-Beispiele formatiert.

Schreibrichtlinien für Webentwicklung lernen

Der Abschnitt "Webentwicklung lernen" von MDN richtet sich speziell an Personen, die die grundlegenden Grundlagen der Webentwicklung lernen, und erfordert daher einen anderen Ansatz als der Rest der MDN-Inhalte. Dieser Artikel bietet Richtlinien zum Schreiben von Lerninhalten.

Wie man für MDN Web Docs schreibt

Dieser Abschnitt behandelt alle Informationen zum Erstellen und Bearbeiten von Seiten, einschließlich bestimmter Prozesse und Techniken, die wir befolgen. Dieser Abschnitt bietet Informationen zum Einstieg, einen allgemeinen Überblick darüber, wie Seiten strukturiert sind, und wo man Anleitungen zu spezifischen Aufgaben findet. Dieser Abschnitt beinhaltet Themen wie:

Wie man eine Technologie recherchiert: Dieser Abschnitt bietet einige nützliche Tipps zur Recherche einer Technologie, die Sie dokumentieren.
Wie man Seiten erstellt, verschiebt und löscht: Dieser Abschnitt erklärt, wie wir eine Seite in den MDN Web Docs erstellen, verschieben oder löschen. Es wird auch erklärt, wie wir eine Seite umleiten, wenn wir die Seite verschieben oder löschen.
Wie man Markdown nutzt: Das Markdown-Format, das wir verwenden, stammt von GitHub flavored markdown (GFM). Dieser Abschnitt ist ein Leitfaden für das Markdown, das wir auf den MDN Web Docs verwenden, einschließlich Formaten für spezifische Seitenelemente wie Anmerkungen und Definitionslisten.
Bilder und Medien hinzufügen: Dieser Abschnitt beschreibt die Anforderungen für die Einbindung von Medien in Seiten, wie Bilder.
Wie man eine CSS-Eigenschaft dokumentiert: Dieser Artikel erklärt, wie man eine Seite für eine CSS-Eigenschaft schreibt, einschließlich Layout und Inhalt.
Wie man eine API-Referenz dokumentiert: Dieser Abschnitt erklärt, wie man an das Dokumentieren einer Web-API herangeht.
Wie man einen HTTP-Header dokumentiert: Dieser Artikel erklärt, wie man eine neue Referenzseite für einen HTTP-Header erstellt.
Wie man einen Eintrag dem Glossar hinzufügt: Dieser Artikel erklärt, wie man Einträge in das Glossar der MDN Web Docs hinzufügt und darauf verlinkt. Außerdem bietet er Richtlinien zum Layout und Inhalt von Glossareinträgen.

Seitentypen auf MDN Web Docs

Jede Seite auf den MDN Web Docs hat einen spezifischen Seitentyp, sei es eine CSS-Referenzseite oder eine JavaScript-Leitfaden-Seite. Dieser Abschnitt listet die verschiedenen Seitentypen und bietet Vorlagen für jeden Typ. Es ist eine gute Idee, diese durchzusehen, um zu verstehen, welchen Seitentyp Sie schreiben.

Seitenstrukturen auf MDN Web Docs

Dieser Abschnitt behandelt die verschiedenen Seitenstrukturen, die wir verwenden, um eine konsistente Darstellung von Informationen auf den MDN Web Docs zu bieten. Dazu gehören:

Syntaxabschnitte: Der Syntaxabschnitt einer Referenzseite auf den MDN Web Docs enthält ein Syntaxfeld, das die genaue Syntax eines Features definiert. Dieser Artikel erklärt, wie man Syntaxfelder für Referenzartikel schreibt.
Code-Beispiele: Es gibt viele verschiedene Möglichkeiten, Code-Beispiele auf Seiten einzubinden. Dieser Abschnitt gibt einen Überblick darüber und bietet Syntaxrichtlinien für die verschiedenen Sprachen.
Banner und Hinweise: Manchmal benötigt ein Artikel einen speziellen Hinweis. Dies könnte der Fall sein, wenn die Seite veraltete Technologie oder anderes Material behandelt, das nicht in Produktionscode verwendet werden sollte. Dieser Artikel umfasst die häufigsten Fälle und wie man sie behandelt.
Spezifikationstabellen: Jede Referenzseite auf den MDN Web Docs sollte Informationen über die Spezifikation(en) enthalten, in der(en) die API oder Technologie definiert wurde. Dieser Artikel zeigt, wie diese Tabellen aussehen und erklärt, wie man sie hinzufügt.
Kompatibilitätstabellen: Die MDN Web Docs haben ein Standardformat für Kompatibilitätstabellen für unsere Open-Web-Dokumentation. Dieser Artikel erklärt, wie man die Datenbank, die zum Erstellen der Kompatibilitätstabellen verwendet wird, hinzufügt und pflegt sowie wie man die Tabellen in Artikel integriert.
Makros: Makros sind Abkürzungen, die auf Seiten verwendet werden, um Inhalte zu generieren, wie z.B. Seitenleisten. Dieser Abschnitt listet die Makros auf, die wir verwenden und was sie tun.

Urheber- und Lizenzierungsinformationen

Beschreibt unsere Richtlinie zur Nutzung von MDN Web Docs-Inhalten anderswo im Internet, wie man die Erlaubnis erhält, Inhalte auf MDN erneut zu veröffentlichen, und Hinweise zum Verlinken auf MDN-Inhalte.

Wie man eine Technologie kennzeichnet

Dieser Abschnitt behandelt unsere Definitionen für die Begriffe obsolet, veraltet und experimentell und bietet Richtlinien dazu, wie man eine Technologie damit kennzeichnet und wann wir Inhalte von den MDN Web Docs entfernen.