Anleitung zur Dokumentation eines HTTP-Headers

• Es gibt viele HTTP-Header, die in verschiedenen IETF-Standards definiert sind.
• IANA führt ein Verzeichnis 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 auf der aktuellen HTTP-Header-Referenz-Übersichtsseite rote Links 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: Request Header, Response Header und Representation 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, die derselben Kategorie angehört.

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

• Beginnen Sie entweder mit unserer Vorlage für HTTP-Header-Seiten oder verwenden Sie die 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 diese Abschnitte haben:

  • Einführender Text, in dem der Header-Name (fett) erwähnt und sein Zweck zusammengefasst wird.
  • Informationsbox, die mindestens den Header-Typ und ob der Header ein verbotener Anfrage-Header ist, enthält.
  • Eine Syntax-Box, 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 zeigt oder wo und wie er normalerweise auftritt.
  • Ein Abschnitt mit Spezifikationen, der relevante RFC-Standarddokumente auflistet.
  • Ein „Weitere Informationen“-Abschnitt, der relevante Ressourcen auflistet.

• Wenn Sie andere HTTP-Header-Seiten betrachtet haben, werden Sie sehen, dass ein {{Compat}}-Makro vorhanden ist, das eine Browser-Tabelle für Sie ausfüllt.
• Die Kompatibilitätstabellenseite wird aus strukturierten Daten generiert. Wenn Sie 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-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, senden Sie sie als Pull-Request. Ein Mitglied unseres Review-Teams wird automatisch zugewiesen, um Ihre Seite zu überprüfen.