Cómo documentar una cabecera HTTP

• Hay muchas cabeceras HTTP definidas en varios estándares IETF.
• IANA mantiene un registro de cabeceras y Wikipedia enumera los campos de cabeceras conocidos, pero no todos son relevantes para los desarrolladores web o son parte de un estándar oficial.
• Si hay enlaces rojos en la página de descripción general de referencia de cabeceras HTTP actual, estas cabeceras son una buena opción para documentar.
• En caso de duda, pregunta al equipo de MDN Web Docs si tiene o no sentido escribir sobre el encabezado que has elegido.

• Las cabeceras HTTP existentes se documentan aquí.
• Hay diferentes categorías de cabeceras: Request header, Response header y Representation header.
• Busque la categoría de la cabcera que está a punto de documentar (tenga en cuenta que algunas cabeceras pueden ser tanto de solicitud como de respuesta, según el contexto).
• Vaya a una página de referencia de cabecera existente que tenga la misma categoría.

• Todas las páginas de cabecera están bajo esta estructura: /docs/Web/HTTP/Headers/
• Para crear una nueva página, consulta las instrucciones en nuestra guía cómo crear una página.

• Comienza desde nuestra plantilla de página de cabecera HTTP o usa una estructura copiada de uno de los documentos de cabecera HTTP existentes que encontraste en el paso 2. Es tu elección.

• Escriba sobre la nueva cabecera HTTP.

• Asegúrate de tener estas secciones:

  • Texto introductorio donde la primera oración menciona el nombre de la cabecera (negrita) y resume su propósito.
  • Cuadro de información que contiene al menos el tipo de cabecera y si la cabecera es un Nombre de cabecera prohibido.
  • Un cuadro de sintaxis que contiene todas las directivas/parámetros/valores posibles de la cabecera HTTP.
  • Una sección que explica estas directivas/valores.
  • Una sección de ejemplo que contiene un caso de uso práctico para esta cabecera o muestra dónde y cómo ocurre normalmente.
  • Una sección de especificaciones que enumera los documentos estándar RFC relevantes.
  • Una sección "Véase también" que enumera recursos relevantes.

• Si has mirado otras páginas de cabecera HTTP, verás que hay una macro {{Compat}} que completará una tabla del navegador por ti.
• La página de la tabla de compatibilidad se genera a partir de datos estructurados. Si desea contribuir con los datos, consulte las instrucciones en https://github.com/mdn/browser-compat-data/blob/main/README.md y envíenos una solicitud de incorporación de cambios (Pull request, en Inglés).

Asegúrate de que tu cabecera está incluida en una categoría adecuada en la página de resumen de referencia de cabeceras HTTP.

Una vez que hayas creado la página de cabecera, envíala como una solicitud de incorporación de cambios (Pull request). Se asignará automáticamente a un miembro de nuestro equipo de revisión para que revise su página.