Leitfaden zum Schreiben

MDN Web Docs ist ein Open-Source-Projekt. Die unten aufgeführten Abschnitte beschreiben unsere Richtlinien für das Was wir dokumentieren und wie wir es auf den MDN Web Docs tun. Um zu erfahren, wie Sie beitragen können, sehen Sie unsere Beitragsrichtlinien.

Was wir schreiben

Dieser Abschnitt behandelt, was wir in den MDN Web Docs einschließen und was nicht, sowie eine Reihe anderer Richtlinien, wie zum Beispiel wann wir über neue Technologien schreiben, den Prozess zum Vorschlagen von Inhalten und ob wir externe Links akzeptieren. Dies ist ein guter Ausgangspunkt, wenn Sie erwägen, Inhalte für uns zu schreiben oder zu aktualisieren. Dieser Abschnitt enthält auch:

Aufnahmekriterien: Bietet eine ausführliche Darstellung der Kriterien für die Aufnahme von Inhalten in die MDN Web Docs, das Bewerbungsverfahren für die Aufnahme neuer Dokumentation und die Erwartungen und Richtlinien für eine bewerbende Partei.

Unser Leitfaden zum Schreibstil

Der Leitfaden zum Schreibstil umfasst die Sprache und den Stil, den wir für das Schreiben auf den MDN Web Docs verwenden. Er behandelt auch, wie Codebeispiele formatiert werden.

Richtlinien zum Schreiben für die Webentwicklung

Der Lernbereich Webentwicklung der MDN richtet sich speziell an Personen, die die grundlegenden Grundlagen der Webentwicklung erlernen, und erfordert daher einen anderen Ansatz als der Rest der Inhalte von MDN. Diese Artikel bieten 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 befolgen. Dieser Abschnitt bietet Informationen zum Einstieg, einen allgemeinen Überblick darüber, wie Seiten strukturiert sind, und wo Sie Anleitungen zu spezifischen Aufgaben finden. Dieser Abschnitt enthält 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 den 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 Markdown-Format, das wir verwenden, leitet sich von GitHub flavored markdown (GFM) ab. Dieser Abschnitt ist ein Leitfaden zum Markdown, das wir auf den MDN Web Docs verwenden, einschließlich Formate für spezielle In-Seite-Komponenten wie Notizen und Definitionslisten.
Bilder und Medien hinzufügen: Dieser Abschnitt beschreibt die Anforderungen für die Einbeziehung von Medien in Seiten, wie Bilder.
Wie man eine CSS-Eigenschaft dokumentiert: Dieser Artikel erklärt, wie man eine CSS-Eigenschaftsseite schreibt, einschließlich Layout und Inhalt.
Wie man eine API-Referenz dokumentiert: Dieser Abschnitt erklärt, wie man an die Dokumentation 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 in das 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 den MDN Web Docs hat einen spezifischen Seitentyp, sei es eine CSS-Referenzseite oder eine JavaScript-Leitfadenseite. Dieser Abschnitt listet die verschiedenen Seitentypen auf und stellt Vorlagen für jeden Typ bereit. 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 Präsentation von Informationen auf den MDN Web Docs zu gewährleisten. Dies umfasst:

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.
Codebeispiele: Es gibt viele verschiedene Möglichkeiten, Codebeispiele auf Seiten einzufügen. Dieser Abschnitt beschreibt sie und bietet Syntaxrichtlinien für die verschiedenen Sprachen.
Banner und Hinweise: Manchmal benötigt ein Artikel einen speziellen Hinweis. Dies kann vorkommen, wenn die Seite veraltete Technologie oder anderes Material behandelt, das nicht im Produktionscode verwendet werden sollte. Dieser Artikel behandelt die häufigsten Fälle und wie man mit ihnen umgeht.
Spezifikationstabellen: Jede Referenzseite auf den MDN Web Docs sollte Informationen über die Spezifikation(en) bereitstellen, in denen die API oder Technologie definiert wurde. Dieser Artikel zeigt, wie diese Tabellen aussehen und erklärt, wie sie hinzugefügt werden können.
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 pflegt, die verwendet wird, um die Kompatibilitätstabellen zu erzeugen und wie man diese Tabellen in Artikel integriert.
Makros: Makros sind Abkürzungen, die auf Seiten zur Generierung von Inhalten verwendet werden, wie zum Beispiel Seitenleisten. Dieser Abschnitt listet die Makros auf, die wir verwenden, und erklärt, was sie tun.

Zuschreibungen und Informationen zur Urheberrechtslizenzierung

Beschreibt unsere Richtlinien zur Verwendung von MDN Web Docs-Inhalten anderswo im Web, wie man die Erlaubnis erhält, Inhalte auf MDN 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.