Anleitung zur Dokumentation eines HTTP-Headers

• Es gibt viele HTTP-Header, die in verschiedenen IETF-Standards definiert sind.
• Die IANA führt ein Register der HTTP-Header-Felder, und Wikipedia listet die bekannten Header-Felder auf, aber nicht alle sind für Webentwickler relevant oder Teil eines offiziellen Standards.
• Wenn es rote Links auf der aktuellen HTTP-Headers-Referenz-Übersichtsseite gibt, sind diese Header eine gute Wahl für die Dokumentation.
• Im Zweifelsfall fragen Sie das MDN Web Docs-Team, ob es sinnvoll ist, über den von Ihnen gewählten Header zu schreiben.

• Bestehende HTTP-Header sind in der HTTP-Referenz dokumentiert.
• Es gibt verschiedene Header-Kategorien: Request header, Response header und Representation header.
• Finden Sie die Kategorie des Headers heraus, den Sie dokumentieren möchten (beachten Sie, dass einige Header sowohl Anfrage- als auch Antwort-Header sein können, je nach Kontext).
• Gehen Sie zu einer vorhandenen Header-Referenzseite, die der gleichen Kategorie angehört.

• Alle Header-Seiten befinden sich unter folgendem Verzeichnis: files/en-us/web/http/reference/headers
• Um eine neue Seite zu erstellen, sehen Sie sich die Anweisungen in unserem Leitfaden zum Erstellen einer Seite an.

• Beginnen Sie entweder mit unserer Vorlage für HTTP-Header-Seiten oder verwenden Sie eine kopierte Struktur einer der bestehenden HTTP-Header-Dokumente, die Sie in Schritt 2 gefunden haben. Die Wahl liegt bei Ihnen.
• Schreiben Sie über den neuen HTTP-Header.
• Stellen Sie sicher, dass Sie diese Abschnitte enthalten:
  • Einführungstext, in dem der erste Satz den Headernamen (fettgedruckt) erwähnt und seinen Zweck zusammenfasst.
  • Informationsbox, die mindestens den Header-Typ enthält und ob es sich um einen Verbotenen Anfrage-Header handelt.
  • Eine Syntaxbox, die alle möglichen Direktiven/Parameter/Werte des HTTP-Headers enthält.
  • Ein Abschnitt, der diese Direktiven/Werte erklärt.
  • Ein Beispielabschnitt, der einen praktischen Anwendungsfall für diesen Header enthält oder zeigt, wo und wie er üblicherweise vorkommt.
  • Ein Abschnitt mit Spezifikationen, der relevante RFC-Standarddokumente auflistet.
  • Ein "Siehe auch"-Abschnitt, der relevante Ressourcen auflistet.

• Wenn Sie sich andere HTTP-Header-Seiten angesehen haben, werden Sie sehen, dass es ein {{Compat}}-Makro gibt, das automatisch eine Browser-Tabelle für Sie ausfüllt.
• Die Kompatibilitäts-Tabelle-Seite wird aus strukturierten Daten generiert. Wenn Sie zu den Daten beitragen möchten, lesen Sie bitte die Anweisungen unter https://github.com/mdn/browser-compat-data/blob/main/README.md und senden Sie uns eine Pull-Anfrage.

Stellen Sie sicher, dass Ihr Header in der entsprechenden Kategorie auf der HTTP-Headers-Referenz-Übersichtsseite aufgelistet ist.

Nachdem Sie die Header-Seite erstellt haben, reichen Sie sie als Pull-Anfrage ein. Ein Mitglied unseres Überprüfungsteams wird automatisch zugewiesen, um Ihre Seite zu überprüfen.