Anleitungen
Dieser Abschnitt der MDN Web Docs Schreibrichtlinien enthält alle schrittweisen Informationen zum Ausführen spezifischer Aufgaben beim Beitrag zu den 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 (was über GitHub geschieht) zu erfahren, siehe unsere Beitragsrichtlinien.
Hinweis: Im gesamten Abschnitt gehen wir 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 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 zur Dokumentation einer CSS-Eigenschaft
Da sich die CSS-Standards weiterentwickeln, werden ständig neue Eigenschaften hinzugefügt. Das CSS-Referenz auf MDN Web Docs muss mit diesen Entwicklungen aktuell gehalten werden. Dieser Artikel bietet eine Schritt-für-Schritt-Anleitung zum Erstellen einer Referenzseite für CSS-Eigenschaften.
- Anleitung zur Dokumentation eines HTTP-Headers
Das HTTP-Header-Referenz auf den MDN Web Docs dokumentiert HTTP-Header-Felder. Diese sind Komponenten des Header-Abschnitts von Anforderungs- und Antwortnachrichten im Hypertext Transfer Protocol (HTTP). Sie definieren die Betriebsparameter einer HTTP-Transaktion. Dieser Artikel erklärt, wie man eine neue Referenzseite für einen HTTP-Header erstellt.
- Anleitung zur Dokumentation von Webfehlern
Der JavaScript-Fehlerreferenz auf den MDN Web Docs ist ein Projekt, das Webentwicklern bei Fehlern hilft, die in der Entwicklerkonsole auftreten. Für dieses Projekt müssen wir mehr Fehlerdokumentationen auf den MDN Web Docs erstellen, damit wir mehr Links zu den Werkzeugen hinzufügen können, wo die Nachrichten ausgegeben werden. In diesem Artikel wird erklärt, wie Sie die Webfehler dokumentieren können.
- Anleitung zur Erstellung, Verschiebung, Löschung und Bearbeitung von Seiten
Dieser Artikel beschreibt, wie Sie eine Seite erstellen, verschieben, löschen oder bearbeiten können. In allen diesen Fällen ist es eine gute Idee, unsere Richtlinien für Was wir schreiben zu überprüfen, um zu bestätigen, ob eine dieser Aktionen durchgeführt werden sollte, und es mit dem MDN Web Docs-Team in den MDN Web Docs-Chatrooms zu besprechen, bevor Sie fortfahren.
- Anleitung zur Hinzufügung 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 aus der
index.md-Datei des Dokuments darauf, indem Sie Markdown-Bildsyntax oder das entsprechende HTML-<img>-Element verwenden.- Anleitung zur Verwendung von Markdown
Diese Seite beschreibt, wie wir Markdown verwenden, um Dokumentation für die MDN Web Docs zu schreiben. Wir haben GitHub-Flavored Markdown (GFM) als Basis gewählt und einige Erweiterungen hinzugefügt, um Dinge zu unterstützen, die wir auf MDN tun müssen, die nicht direkt in GFM unterstützt werden.
- Anleitung zur Verwendung von strukturierten Daten
MDN speichert Daten in gut definierten Strukturen, wann immer dies möglich ist. Diese Informationen werden dann zentralisiert und können einmalig aktualisiert und an vielen Stellen genutzt werden.
- Wie man eine Technologie recherchiert
Dieser Artikel gibt Ihnen nützliche Informationen darüber, wie Sie an die Dokumentation von Technologien herangehen können.
- Wie man einen Eintrag im Glossar schreibt
Dieser Artikel erklärt, wie Sie Einträge im MDN Web Docs-Glossar hinzufügen und verlinken können. Er bietet auch Leitlinien zum Layout und Inhalt von Glossareinträgen. Das Glossar liefert Definitionen für alle Begriffe, Fachausdrücke, Abkürzungen und Akronyme, die Sie beim Lesen von MDN-Inhalten über das Web und Webentwicklung antreffen.