Schreibrichtlinien
MDN Web Docs ist ein Open-Source-Projekt. Die unten beschriebenen Abschnitte erläutern unsere Richtlinien zum Was und Wie der Dokumentation auf MDN Web Docs. Um mehr darüber zu erfahren, wie Sie beitragen können, sehen Sie sich unsere Beitragsrichtlinien an.
- Was wir schreiben
-
Dieser Abschnitt behandelt, was wir in den MDN Web Docs einbeziehen und was nicht, sowie eine Reihe weiterer Richtlinien, wie z.B. wann wir über neue Technologien schreiben, den Prozess für Inhaltvorschlä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.
- Aufnahmekriterien
-
Dieser Artikel beschreibt detailliert die Kriterien für Inhalte, die in die MDN Web Docs aufgenommen werden sollen, den Bewerbungsprozess für die Aufnahme neuer Dokumentation und Erwartungen und Richtlinien für eine Partei, die sich bewirbt.
- Unser Leitfaden für Schreibstil
-
Der Schreibstil-Leitfaden behandelt die Sprache und den Stil, die wir zum Schreiben auf MDN Web Docs verwenden. Er deckt auch ab, wie man Code-Beispiele formatiert.
- Schreibrichtlinien für die Webentwicklung lernen
-
Der Abschnitt "Webentwicklung lernen" 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 Leitlinien für das Schreiben von Lerninhalten.
- Anleitung für das Schreiben für MDN Web Docs
-
Dieser Abschnitt enthält alle Informationen zum Erstellen und Bearbeiten von Seiten, 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 man Anleitungen zu spezifischen Aufgaben findet. Dieser Abschnitt umfasst Themen wie:
- Wie man eine Technologie recherchiert
-
Dieser Abschnitt bietet einige hilfreiche Tipps zur Recherche einer Technologie, die Sie dokumentieren.
- Wie man Seiten erstellt, verschiebt und löscht
-
Dieser Abschnitt erklärt, wie wir eine Seite in 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 einen Abschnitt von Inhalten in den Ruhestand versetzt
-
Dieser Abschnitt erklärt den Prozess, um ganze Abschnitte der MDN Web Docs-Inhalte planmäßig und transparent in den Ruhestand zu versetzen, einschließlich Entscheidungsfindung, Vorankündigungsfristen, Archivierung und Entfernung.
- 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 MDN Web Docs verwenden, einschließlich Formate für spezifische Komponenten innerhalb der Seite, wie Notizen und Definitionslisten.
- Hinzufügen von Bildern und Medien
-
Dieser Abschnitt beschreibt die Anforderungen für das Einschließen 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 zum Glossar hinzufügt
-
Dieser Artikel erklärt, wie man Einträge im MDN Web Docs-Glossar hinzufügt und verlinkt. Er bietet auch Leitlinien für das Layout und den 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 Präsentation von Informationen auf MDN Web Docs zu bieten. Dies umfasst:
- Syntax-Abschnitte
-
Der Syntaxabschnitt einer Referenzseite auf MDN Web Docs enthält ein Syntaxfeld, das die genaue Syntax eines Merkmals definiert. Dieser Artikel erklärt, wie man Syntaxfelder für Referenzartikel schreibt.
- Code-Beispiele
-
Es gibt viele verschiedene Möglichkeiten, Code-Beispiele auf Seiten einzuschließen. Dieser Abschnitt umreißt sie und bietet Syntaxrichtlinien für die verschiedenen Sprachen.
-
Manchmal benötigt ein Artikel einen speziellen Hinweis. Dies könnte geschehen, wenn die Seite veraltete Technologien 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 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 Open-Web-Dokumentation. Dieser Artikel erklärt, wie man die Datenbank, die zur Generierung der Kompatibilitätstabellen verwendet wird, ergänzt und pflegt sowie wie man die Tabellen in Artikel integriert.
- Makros
-
Makros sind Abkürzungen, die auf Seiten verwendet werden, um Inhalte zu generieren, wie z.B. Seitenleisten. Dieser Abschnitt listet die Makros auf, die wir verwenden, und was sie tun.
- Zuschreibungen und Informationen zur Urheberrechtslizenzierung
-
Beschreibt unsere Richtlinien zur Verwendung der MDN Web Docs-Inhalte anderswo im Web, wie man die Erlaubnis erhält, Inhalte auf MDN neu 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, überholt und experimentell und bietet Leitlinien dafür, wie eine Technologie damit gekennzeichnet werden soll und wann wir Inhalte von MDN Web Docs entfernen.