Schreibrichtlinien

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

Was wir schreiben

Dieser Abschnitt behandelt, was wir in MDN Web Docs aufnehmen und was nicht, sowie mehrere andere Richtlinien, z. B. wann wir über neue Technologien schreiben, den Inhaltssvorschlagsprozess und ob wir externe Links akzeptieren. Dies ist ein guter Ausgangspunkt, wenn Sie erwägen, Inhalte für uns zu schreiben oder zu aktualisieren.

Einschlusskriterien

Dieser Artikel beschreibt im Detail die Kriterien für die Aufnahme von Inhalten in MDN Web Docs, den Antragsprozess für die Aufnahme neuer Dokumentationen und Erwartungen sowie Richtlinien für eine Partei, die einen Antrag stellt.

Unser Leitfaden für den Schreibstil

Der Schreibstil-Leitfaden deckt die Sprache und den Stil ab, die wir beim Schreiben auf MDN Web Docs verwenden. Er behandelt auch, wie man Codebeispiele formatiert.

Schreibrichtlinien für die Webentwicklung lernen

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

Anleitung zum Schreiben für MDN Web Docs

Dieser Abschnitt behandelt alle Informationen zum Erstellen und Bearbeiten von Seiten, einschließlich bestimmter Prozesse und Techniken, an die wir uns halten. Dieser Abschnitt bietet Informationen zum Einstieg, einen allgemeinen Überblick darüber, wie Seiten strukturiert sind, und wo Sie Anleitungen zu bestimmten Aufgaben finden können. Dieser Abschnitt umfasst 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 auf MDN Web Docs erstellen, verschieben oder löschen. Es wird auch erklärt, wie wir eine Seite umleiten, wenn wir sie verschieben oder löschen.
Wie man Markdown verwendet: Das von uns verwendete Markdown-Format leitet sich von GitHub flavored markdown (GFM) ab. Dieser Abschnitt ist ein Leitfaden zum Markdown, das wir auf MDN Web Docs verwenden, einschließlich Formaten für bestimmte Seitenelemente wie Notizen und Definitionslisten.
Bilder und Medien hinzufügen: Dieser Abschnitt beschreibt die Anforderungen für die Einbindung von Medien in Seiten, wie z. B. Bilder.
Wie man eine CSS-Eigenschaft dokumentiert: Dieser Artikel erklärt, wie man eine Seite zu einer CSS-Eigenschaft schreibt, einschließlich Layout und Inhalt.
Wie man eine API-Referenz dokumentiert: Dieser Abschnitt erklärt, wie man eine Web-API dokumentiert.
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 bestimmten 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 durchstöbern, 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 MDN Web Docs zu gewährleisten. Dies umfasst:

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 einzufügen. Dieser Abschnitt skizziert diese und bietet Syntaxrichtlinien für die verschiedenen Sprachen.
Banner und Hinweise: Manchmal benötigt ein Artikel eine spezielle Anmerkung. Dies kann der Fall sein, wenn die Seite veraltete Technologie oder anderes Material abdeckt, das in Produktionscode nicht verwendet werden sollte. Dieser Artikel behandelt die häufigsten Fälle und wie man damit umgeht.
Spezifikationstabellen: Jede Referenzseite auf MDN Web Docs sollte Informationen über die Spezifikation(en) bereitstellen, in denen diese 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 und pflegt, die verwendet wird, um die Kompatibilitätstabellen zu erstellen, 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 Makros auf, die wir verwenden, und ihre Funktionen.

Zuschreibungen und urheberrechtliche Lizenzinformationen

Beschreibt unsere Richtlinie zur Verwendung von MDN Web Docs-Inhalten an anderer Stelle 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 obsolet, veraltet und experimentell und bietet Richtlinien, wie man eine Technologie damit kennzeichnet und wann wir Inhalte von MDN Web Docs entfernen.