Schreibrichtlinien
MDN Web Docs ist ein Open-Source-Projekt. Die unten beschriebenen Abschnitte skizzieren unsere Richtlinien dafür, was wir dokumentieren und wie wir es auf MDN Web Docs tun. Um mehr über die Beitragserstellung zu erfahren, siehe unsere Richtlinien für Beiträge.
- 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 Prozess der Inhaltsvorschläge und ob wir externe Links akzeptieren. Dies ist ein guter Ausgangspunkt, wenn Sie darüber nachdenken, für uns Inhalte zu schreiben oder zu aktualisieren.
- Einschlusskriterien
-
Dieser Artikel beschreibt im Detail die Kriterien für die Aufnahme von Inhalten auf MDN Web Docs, den Anwendungsprozess zur Einbeziehung neuer Dokumentationen sowie Erwartungen und Richtlinien für Antragsteller.
- Unser Schreibstil-Leitfaden
-
Der Schreibstil-Leitfaden beschreibt die Sprache und den Stil, den wir auf MDN Web Docs verwenden. Er behandelt auch, wie wir Codebeispiele formatieren.
- Richtlinien für das Schreiben über Webentwicklung
-
Der Abschnitt "Webentwicklung lernen" von MDN richtet sich speziell an diejenigen, 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 für das Schreiben für MDN Web Docs
-
Dieser Abschnitt umfasst alle Informationen zur Erstellung und Bearbeitung von Seiten, einschließlich bestimmter Prozesse und Techniken, die wir befolgen. Dieser Abschnitt enthält Informationen zum Einstieg, einen allgemeinen Überblick über den Aufbau von Seiten und wo Sie Anleitungen zu spezifischen Aufgaben finden können. Dieser Abschnitt umfasst Themen wie:
- Wie man eine Technologie recherchiert
-
Dieser Abschnitt bietet einige nützliche Tipps für die 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. Er erklärt auch, wie wir eine Seite umleiten, wenn wir sie verschieben oder löschen.
- Wie man einen Abschnitt von Inhalten zurückzieht
-
Dieser Abschnitt erklärt den Prozess des geplanten und transparenten Zurückziehens ganzer Abschnitte von MDN Web Docs-Inhalten, einschließlich Entscheidungsfindung, Ankündigungsfristen, Archivierung und Entfernung.
- Wie man Markdown benutzt
-
Das von uns verwendete Markdown-Format leitet sich von GitHub flavored markdown (GFM) ab. Dieser Abschnitt ist ein Leitfaden für das Markdown, das wir auf MDN Web Docs verwenden, einschließlich der Formate für spezifische Seitenelemente wie Notizen und Definitionslisten.
- Bilder und Medien hinzufügen
-
Dieser Abschnitt beschreibt die Anforderungen für die Einbeziehung von Medien auf Seiten, wie z. B. Bildern.
- 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 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 zum Glossar hinzufügt
-
Dieser Artikel erklärt, wie man Einträge in das MDN Web Docs Glossar hinzufügt und verlinkt. Er bietet auch Richtlinien zum Layout und Inhalt von Glossar-Einträ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 deckt die verschiedenen Seitenstrukturen ab, die wir verwenden, um eine konsistente Darstellung von Informationen auf MDN Web Docs zu gewährleisten. Dazu gehören:
- 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 zu integrieren. Dieser Abschnitt gibt einen Überblick darüber und bietet Syntaxrichtlinien für die verschiedenen Sprachen.
-
Manchmal benötigt ein Artikel einen besonderen Hinweis. Dies kann der Fall sein, wenn die Seite veraltete Technologien oder anderes Material behandelt, das nicht im Produktionscode verwendet werden sollte. Dieser Artikel behandelt die häufigsten Fälle und deren Handhabung.
- Spezifikationstabellen
-
Jede Referenzseite auf MDN Web Docs sollte Informationen über die Spezifikation oder Spezifikationen enthalten, 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 offene Webdokumentation. Dieser Artikel erklärt, wie man die Datenbank pflegt und erweitert, die für die Generierung 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 erzeugen, wie z. B. Seitenleisten. Dieser Abschnitt listet die Makros auf, die wir verwenden, und erklärt, was sie tun.
- Zuordnungen und Urheberrechtslizenzinformationen
-
Beschreibt unsere Richtlinie zur Nutzung von MDN Web Docs-Inhalten an anderer Stelle im Web, wie man die Erlaubnis zur Wiedergabe von Inhalten auf MDN erhält und Tipps zum Verlinken zu 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 mit diesen Begriffen kennzeichnet und wann wir Inhalte von MDN Web Docs entfernen.