Anleitungen für MDN-Beitragende
Dieser Abschnitt der MDN Web Docs-Schreibrichtlinien enthält die Schritt-für-Schritt-Details zur Ausführung spezifischer Aufgaben beim Beitrag zu MDN Web Docs: wie wir Markdown verwenden, wie wir einen Eintrag zum Glossar hinzufügen, wie wir Seiten verschieben oder löschen und mehr.
Um mehr über wie man beiträgt zu erfahren, sehen Sie sich unsere Beitragsrichtlinien an.
Diese Dokumente gehen davon aus, dass Sie die Beitragsrichtlinien gelesen haben, mit dem mdn/content Repository vertraut sind und wissen, wie man git und GitHub verwendet.
- Anleitung zum Erstellen, Bearbeiten, Verschieben oder Löschen von Seiten
Dieser Artikel beschreibt, wie Sie eine Seite erstellen, verschieben, löschen oder bearbeiten können. In all diesen Fällen ist es eine gute Idee, unsere Richtlinien zu Was wir schreiben zu überprüfen, um zu bestätigen, ob eine dieser Aktionen durchgeführt werden sollte, und es vorab mit dem Team in einem der MDN Web Docs Kommunikationskanäle zu besprechen.
- Anleitung zum Hinzufügen eines Glossareintrags
Dieser Artikel erklärt, wie man Einträge im MDN Web Docs Glossar hinzufügt und verlinkt. Er gibt auch Richtlinien zum Layout und Inhalt von Glossareinträgen. Das Glossar bietet Definitionen für alle Begriffe, Jargon, Abkürzungen und Akronyme, die Ihnen beim Lesen von MDN-Inhalten über das Web und die Webentwicklung begegnen.
- Anleitung zum Hinzufügen von Bildern und Medien
Um ein Bild zu einem Dokument hinzuzufügen, fügen Sie Ihre Bilddatei in den Ordner des Dokuments ein und verweisen Sie dann im
index.md-Dokument mit der Markdown-Bildsyntax oder dem entsprechenden HTML-<img>-Element auf das Bild.- Anleitung zum Schreiben einer API-Referenz
Dieser Leitfaden führt Sie durch alles, was Sie wissen müssen, um eine API-Referenz auf MDN zu schreiben.
- Anleitung zum Schreiben in Markdown
Diese Seite beschreibt, wie wir Markdown verwenden, um Dokumentationen in den MDN Web Docs zu schreiben. Wir haben GitHub-Flavored Markdown (GFM) als Grundlage gewählt und einige Erweiterungen hinzugefügt, um einige der Dinge zu unterstützen, die wir auf MDN tun müssen, die in GFM nicht sofort unterstützt werden.
- Anleitung zur Dokumentation einer CSS-Eigenschaft
Mit der Weiterentwicklung der CSS-Standards werden ständig neue Eigenschaften hinzugefügt. Die CSS-Referenz auf MDN Web Docs muss regelmäßig mit diesen Entwicklungen aktualisiert werden. Dieser Artikel bietet eine schrittweise Anleitung zum Erstellen einer Referenzseite für CSS-Eigenschaften.
- Anleitung zur Dokumentation eines HTTP-Headers
Die HTTP-Headers-Referenz dokumentiert den Header-Abschnitt von Anfrage- und Antwortnachrichten im Hypertext Transfer Protocol (HTTP). Dieser Artikel erklärt, wie Sie eine neue Referenzseite für einen HTTP-Header erstellen.
- Anleitung zur Dokumentation von Webfehlern
Der JavaScript-Fehlerreferenz auf MDN Web Docs ist ein Projekt, das Webentwicklern bei Fehlern hilft, die in der Entwicklerkonsole auftreten. Für dieses Projekt müssen wir mehr Fehlerdokumentation auf MDN Web Docs verfassen, damit wir mehr Links zu den Tools hinzufügen können, in denen die Nachrichten ausgegeben werden. Dieser Artikel erklärt, wie man Webfehler dokumentiert.
- Anleitung zur Recherche einer Technologie
Dieser Artikel gibt Ihnen nützliche Informationen darüber, wie Sie Technologien dokumentieren können.
- Anleitung zur Verwendung strukturierter Daten
MDN speichert Daten nach Möglichkeit in klar definierten Strukturen. Diese Informationen werden zentralisiert und können einmal aktualisiert werden, um in zahlreichen Bereichen genutzt zu werden.