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.
• Wenn es rote Links auf der aktuellen HTTP-Header-Referenzübersichtsseite gibt, sind diese Header eine gute Wahl zur Dokumentation.
• Wenn Sie unsicher sind, fragen Sie das MDN Web Docs Team, ob es sinnvoll ist, über den von Ihnen gewählten Header zu schreiben.

• Bestehende HTTP-Header sind hier dokumentiert.
• Es gibt verschiedene Header-Kategorien: Anfrage-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 Anfrage- als auch Antwort-Header sein können).
• Gehen Sie zu einer bestehenden Header-Referenzseite mit derselben Kategorie.

• 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.

• Entweder starten Sie mit unserer Vorlage für HTTP-Header-Seiten oder verwenden Sie eine kopierte Struktur von einem der bestehenden HTTP-Header-Dokumente, die Sie in Schritt 2 gefunden haben. Es liegt an Ihnen.

• Schreiben Sie über den neuen HTTP-Header.

• Stellen Sie sicher, dass Sie folgende Abschnitte einfügen:

  • Einleitungstext, in dem der Header-Name (fett) genannt und dessen Zweck zusammengefasst wird.
  • Informationsbox, die mindestens den Header-Typ und ob der Header ein verbotener Anfrage-Header ist, enthält.
  • Eine Syntaxbox mit allen möglichen Direktiven/Parametern/Werten des HTTP-Headers.
  • Ein Abschnitt, der diese Direktiven/Werte erklärt.
  • Ein Beispielabschnitt, der eine praktische Anwendung für diesen Header enthält oder zeigt, wo und wie er üblicherweise auftritt.
  • Einen Abschnitt Spezifikationen, der relevante RFC-Standarddokumente auflistet.
  • Einen Abschnitt "Siehe auch", der relevante Ressourcen auflistet.

• Wenn Sie andere HTTP-Header-Seiten betrachtet haben, werden Sie sehen, dass es ein {{Compat}} Makro gibt, das Ihnen eine Browser-Tabelle ausfüllt.
• Die Kompatibilitätstabelle 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 einen Pull-Request.

Stellen Sie sicher, dass Ihr Header in einer geeigneten Kategorie auf der HTTP-Header-Referenzübersichtsseite aufgeführt ist.

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