Schreibrichtlinien

MDN Web Docs ist ein Open-Source-Projekt. Die unten aufgeführten Abschnitte beschreiben unsere Richtlinien für was wir dokumentieren und wie wir dies auf MDN Web Docs tun. Um mehr über wie man beiträgt zu erfahren, lesen Sie unsere Beitragsrichtlinien.

Was wir schreiben

Dieser Abschnitt behandelt, was wir auf MDN Web Docs einbeziehen und was nicht, sowie eine Reihe anderer Richtlinien, wie z.B. wann wir über neue Technologien schreiben, den Vorschlagsprozess für Inhalte und ob wir externe Links akzeptieren. Dies ist ein guter Ausgangspunkt, wenn Sie in Erwägung ziehen, Inhalte für uns zu schreiben oder zu aktualisieren. Dieser Abschnitt umfasst auch:

Aufnahmekriterien: Bietet detaillierte Kriterien für Inhalte, die auf MDN Web Docs aufgenommen werden, den Bewerbungsprozess, um neue Dokumentationen auf MDN Web Docs hinzuzufügen, und die Erwartungen und Richtlinien für eine Partei, die sich bewirbt.

Unser Styleguide für das Schreiben

Der Styleguide für das Schreiben behandelt die Sprache und den Stil, die wir auf MDN Web Docs verwenden. Er behandelt auch, wie man Codebeispiele formatiert.

Anleitung für das Schreiben auf MDN Web Docs

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

Wie man eine Technologie recherchiert: Dieser Abschnitt bietet einige praktische Tipps zum Recherchieren einer Technologie, die Sie dokumentieren.
Wie man Seiten erstellt, verschiebt und löscht: Dieser Abschnitt erklärt, wie wir eine Seite auf MDN Web Docs erstellen, verschieben oder löschen. Er erklärt auch, wie wir eine Seite umleiten, wenn wir sie verschieben oder löschen.
Wie man Markdown verwendet: Das von uns verwendete Markdown-Format basiert auf GitHub flavored markdown (GFM). Dieser Abschnitt ist ein Leitfaden für das Markdown, das wir auf MDN Web Docs verwenden, einschließlich Formate für spezifische Seitenelemente, wie Notizen und Definitionslisten.
Bilder und Medien hinzufügen: Dieser Abschnitt beschreibt die Anforderungen für das Einbinden von Medien auf 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 ein API-Referenzdokument erstellt: 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 zum Glossar hinzufügt: Dieser Artikel erklärt, wie man Einträge im MDN Web Docs Glossar hinzufügt und verlinkt. Er bietet auch Richtlinien zum Layout und Inhalt von Glossareinträgen.

Seitentypen auf MDN Web Docs

Jede Seite auf MDN Web Docs hat einen spezifischen Seitentyp, sei es eine CSS-Referenzseite oder eine JavaScript-Leitfaden-Seite. Dieser Abschnitt listet die verschiedenen Seitentypen auf und bietet Vorlagen für jeden Typ. Es ist eine gute Idee, diese zu durchsuchen, 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 der Informationen auf MDN Web Docs zu gewährleisten. Dies beinhaltet:

Syntaxabschnitte: Der Syntaxabschnitt einer Referenzseite auf 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.
Codebeispiele: Es gibt viele verschiedene Möglichkeiten, Codebeispiele auf Seiten einzubinden. Dieser Abschnitt skizziert sie 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 behandelt die häufigsten Fälle und wie man mit ihnen umgeht.
Spezifikationstabellen: Jede Referenzseite auf MDN Web Docs sollte Informationen über die Spezifikation(en) enthalten, in der/denen die API oder Technologie definiert wurde. Dieser Artikel zeigt, wie diese Tabellen aussehen und erklärt, wie man sie hinzufügt.
Kompatibilitätstabellen: MDN Web Docs hat ein Standardformat für Kompatibilitätstabellen für unsere Open-Web-Dokumentation. Dieser Artikel erklärt, wie man die Datenbank aktualisiert, die zur Erstellung der Kompatibilitätstabellen verwendet wird, sowie wie man die Tabellen in Artikel integriert.
Makros: Makros sind Abkürzungen, die in Seiten verwendet werden, um Inhalte zu generieren, wie z.B. Seitenleisten. Dieser Abschnitt listet die von uns verwendeten Makros auf und erklärt ihre Funktionen.

Quellenangaben und Informationen zur urheberrechtlichen Lizenzierung

Beschreibt unsere Richtlinien zur Verwendung von Inhalten von MDN Web Docs an anderen Stellen im Web, wie man die Erlaubnis erhält, Inhalte auf MDN zu veröffentlichen, und Tipps zum Verlinken von MDN-Inhalten.

Wie man eine Technologie kennzeichnet

Dieser Abschnitt behandelt unsere Definitionen für die Begriffe veraltet, abgelehnt und experimentell und bietet Richtlinien dazu, wie man eine Technologie mit diesen Begriffen kennzeichnet und wann wir Inhalte aus MDN Web Docs entfernen.