Anleitung zur Dokumentation eines HTTP-Headers

• Es gibt viele HTTP-Header, die in verschiedenen IETF-Standards definiert sind.
• 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.
• Falls es rote Links auf der aktuellen Übersichtsseite der HTTP-Header-Referenz gibt, sind diese Header eine gute Wahl zum Dokumentieren.
• Bei Unsicherheiten fragen Sie das MDN Web Docs-Team, ob es sinnvoll ist, über den von Ihnen gewählten Header zu schreiben.

• Vorhandene HTTP-Header sind hier dokumentiert.
• Es gibt verschiedene Header-Kategorien: Anforderungs-Header, Antwort-Header und Repräsentations-Header.
• Finden Sie die Kategorie des Headers, den Sie dokumentieren möchten (beachten Sie, dass einige Header je nach Kontext sowohl Anforderungs- als auch Antwort-Header sein können).
• Gehen Sie zu einer bestehenden Header-Referenzseite, die dieselbe Kategorie hat.

• Alle Header-Seiten befinden sich unter diesem Pfad: /docs/Web/HTTP/Headers/
• Um eine neue Seite zu erstellen, folgen Sie den Anweisungen in unserem Leitfaden zur Seitenerstellung.

• Beginnen Sie entweder mit unserer Vorlagen-HTTP-Header-Seite oder nutzen Sie eine kopierte Struktur von einem der bestehenden HTTP-Header-Dokumente, die Sie in Schritt 2 gefunden haben. Das bleibt Ihnen überlassen.

• Schreiben Sie über den neuen HTTP-Header.

• Stellen Sie sicher, dass Sie diese Abschnitte enthalten:

  • Einführungstext, in dem der Headername (fett) und sein Zweck zusammengefasst werden.
  • Informationsfeld, das mindestens den Header-Typ und ob der Header ein forbidden header name ist, enthält.
  • Ein Syntaxfeld, das 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 auftritt.
  • Einen Abschnitt Spezifikation, der relevante RFC-Standarddokumente auflistet.
  • Einen Abschnitt "Siehe auch", der relevante Ressourcen auflistet.

• Wenn Sie sich andere HTTP-Header-Seiten angesehen haben, werden Sie sehen, dass es ein {{Compat}} Makro gibt, das Ihnen eine Browser-Tabelle ausfüllen wird.
• Die Kompatibilitätstabellen-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 einer geeigneten Kategorie auf der Übersichtsseite der HTTP-Header-Referenz aufgeführt ist.

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