Anleitung zum Dokumentieren eines HTTP-Headers

• Es gibt viele HTTP-Header, die in verschiedenen IETF-Standards definiert sind.
• IANA pflegt 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 Übersichtsseite der HTTP-Headers-Referenz gibt, sind diese Header eine gute Wahl, um dokumentiert zu werden.
• Wenn Sie unsicher sind, fragen Sie das MDN Web Docs Team, ob es sinnvoll ist, über den von Ihnen gewählten Header zu schreiben.

• Vorhandene HTTP-Header werden hier dokumentiert.
• Es gibt verschiedene Header-Kategorien: Anforderungsheader, Antwortheader und Repräsentationsheader.
• Finden Sie die Kategorie des Headers, den Sie dokumentieren möchten (beachten Sie, dass einige Header je nach Kontext sowohl Anforderungs- als auch Antwortheader sein können).
• Gehen Sie zu einer vorhandenen Header-Referenzseite, die zur gleichen Kategorie gehört.

• Alle Header-Seiten befinden sich unter folgendem Pfad: files/en-us/web/http/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 von einem der vorhandenen HTTP-Header-Dokumente, die Sie in Schritt 2 gefunden haben. Die Entscheidung liegt bei Ihnen.

• Schreiben Sie über den neuen HTTP-Header.

• Achten Sie darauf, dass Sie diese Abschnitte haben:

  • Ein einleitender Text, in dem im ersten Satz der Header-Name (fett) erwähnt und sein Zweck zusammengefasst wird.
  • Eine Informationsbox, die mindestens den Header-Typ enthält und ob der Header ein verbotener Anforderungsheader ist.
  • Eine Syntax-Box, die alle möglichen Direktiven/Parameter/Werte des HTTP-Headers enthält.
  • Einen Abschnitt, der diese Direktiven/Werte erklärt.
  • Einen Beispielabschnitt, der einen praktischen Anwendungsfall für diesen Header enthält oder zeigt, wo und wie er üblicherweise vorkommt.
  • Einen Abschnitt mit Spezifikationen, der relevante RFC-Standarddokumente auflistet.
  • Einen "Siehe auch"-Abschnitt, der relevante Ressourcen auflistet.

• Wenn Sie sich andere HTTP-Header-Seiten angesehen haben, werden Sie feststellen, dass es ein {{Compat}} Makro gibt, das für Sie eine Browser-Tabelle einfügt.
• Die Seite der Kompatibilitäts-Tabelle 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 einer geeigneten Kategorie auf der Übersichtsseite der HTTP-Headers-Referenz aufgeführt ist.

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