Schreibrichtlinien

MDN Web Docs ist ein Open-Source-Projekt. Die nachfolgenden Abschnitte beschreiben unsere Richtlinien für das Was wir dokumentieren und das Wie wir es auf MDN Web Docs umsetzen. Um mehr darüber zu erfahren, wie Sie beitragen können, lesen Sie unsere Beitragsrichtlinien.

Was wir schreiben

Dieser Abschnitt behandelt, was wir auf MDN Web Docs aufnehmen und was nicht, sowie eine Reihe anderer Richtlinien, wie z. B., wann wir über neue Technologien schreiben, den Prozess für Inhaltsvorschläge 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 beinhaltet auch:

Aufnahmekriterien: Beschreibt die detaillierten Kriterien für Inhalte, die bei MDN Web Docs aufgenommen werden, den Bewerbungsprozess für das Hinzufügen neuer Dokumentationen zu MDN Web Docs sowie die Erwartungen und Richtlinien für Bewerbende.

Unser Leitfaden für Schreibstile

Der Leitfaden für Schreibstile behandelt die Sprache und den Stil, die wir beim Schreiben für MDN Web Docs verwenden. Er enthält auch Informationen darüber, wie Code-Beispiele formatiert werden.

Richtlinien für Lerninhalte zur Webentwicklung

Der Abschnitt Learn web development von MDN richtet sich speziell an Personen, die die grundlegenden Grundlagen der Webentwicklung erlernen. Daher erfordert er eine andere Herangehensweise als der Rest der MDN-Inhalte. Dieser Artikel liefert Richtlinien für das Schreiben von Lerninhalten.

Anleitung zum Schreiben für MDN Web Docs

Dieser Abschnitt deckt alle Informationen zum Erstellen und Bearbeiten von Seiten ab, einschließlich bestimmter Prozesse und Techniken, die wir anwenden. Dieser Abschnitt enthält Informationen über den Einstieg, eine allgemeine Übersicht über den Aufbau von Seiten und wo Sie Anleitungen zu spezifischen Aufgaben finden. Dieser Abschnitt umfasst Themen wie:

Wie man eine Technologie recherchiert: Diese Sektion liefert nützliche Tipps dazu, wie Sie eine zu dokumentierende Technologie recherchieren können.
Wie man Seiten erstellt, verschiebt und löscht: Diese Sektion erklärt, wie wir Seiten auf MDN Web Docs erstellen, verschieben oder löschen. Sie beschreibt auch, wie wir eine Umleitung einrichten, wenn eine Seite verschoben oder gelöscht wird.
Wie man Markdown verwendet: Das von uns verwendete Markdown-Format basiert auf GitHub Flavored Markdown (GFM). Diese Sektion ist ein Leitfaden zum Markdown-Format, das wir auf MDN Web Docs verwenden, einschließlich der Formate für spezifische Seitenelemente wie Hinweise und Definitionslisten.
Bilder und Medien hinzufügen: Diese Sektion beschreibt die Anforderungen an das Einfügen von Medien auf Seiten, wie z. B. Bildern.
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 das Dokumentieren einer Web-API angeht.
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 im Glossar hinzufügt: Dieser Artikel erklärt, wie man Einträge zum Glossar von MDN Web Docs hinzufügt und verlinkt. Er enthält auch Richtlinien zum Layout und Inhalt von Glosseireneinträ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 stellt Vorlagen für jeden Typ bereit. Es ist sinnvoll, diese anzusehen, um zu verstehen, welchen Seitentyp Sie schreiben.

Seitenstrukturen auf MDN Web Docs

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

Syntaxabschnitte: Der Syntaxabschnitt einer Referenzseite auf MDN Web Docs enthält ein Syntaxfeld, das die genaue Syntax einer Funktion 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. Diese Sektion beschreibt diese und gibt Syntaxrichtlinien für die verschiedenen Programmiersprachen.
Banderolen und Hinweise: Manchmal benötigt ein Artikel einen speziellen Hinweis. Dies könnte der Fall sein, wenn die Seite eine veraltete Technologie oder anderes Material behandelt, das nicht in Produktionscode verwendet werden sollte. Dieser Artikel deckt die häufigsten Fälle und deren Handhabung ab.
Spezifikationstabellen: Jede Referenzseite auf MDN Web Docs sollte Informationen über die Spezifikationen enthalten, in denen diese API oder Technologie definiert wurde. Dieser Artikel zeigt, wie diese Tabellen aussehen und erklärt, wie sie hinzugefügt werden.
Kompatibilitätstabellen: MDN Web Docs hat ein Standardformat für Kompatibilitätstabellen in unserer offenen Web-Dokumentation. Dieser Artikel erklärt, wie man die Datenbank, die für die Erstellung der Tabellen verwendet wird, erweitert und pflegt sowie wie man Tabellen in Artikel integriert.
Makros: Makros sind Abkürzungen, die in Seiten verwendet werden, um Inhalte wie Seitenleisten zu generieren. Dieser Abschnitt listet die von uns verwendeten Makros auf und was sie leisten.

Zuschreibungen und Informationen zu Urheberrechtslizenzen

Beschreibt unsere Richtlinien zur Verwendung von MDN Web Docs Inhalten anderswo im Web, wie Sie die Erlaubnis erhalten, Inhalte von MDN zu veröffentlichen, sowie Tipps zur Verlinkung von MDN-Inhalten.

Wie man eine Technologie kennzeichnet

Dieser Abschnitt behandelt unsere Definitionen für die Begriffe obsolet, veraltet und experimentell und gibt Richtlinien, wie und wann eine Technologie entsprechend gekennzeichnet wird und wann Inhalte von MDN Web Docs entfernt werden.