Referencia
De un vistazo
Sección titulada «De un vistazo»Esta sección es el punto de entrada al contenido de referencia: inventarios de API, claves de configuración, tablas de compatibilidad, comportamiento de CSS admitido y registros de cobertura entre paquetes.
Mapa de referencia
Sección titulada «Mapa de referencia»| Referencia | Qué responde |
|---|---|
| Matriz de compatibilidad con CSS | Qué características de CSS están verificadas, declaradas, marcadas como parciales o no admitidas en la canalización de HTML. |
| Índice de la API de integraciones | Qué página de la API de extensión corresponde a cada framework, renderer, transporte y herramienta de compilación. |
| Secciones de integración | Dónde encontrar la referencia de API y de configuración específica de cada paquete. |
| Referencia del módulo Core | Páginas de API y de arquitectura de nivel de módulo generadas a partir del repositorio core. |
Contrato de las entradas de referencia
Sección titulada «Contrato de las entradas de referencia»Cada entrada de API debe responder a las mismas preguntas:
| Pregunta | Respuesta obligatoria |
|---|---|
| ¿Qué se invoca? | Símbolo completamente cualificado, endpoint, comando de CLI o clave de configuración. |
| ¿Qué entrada se acepta? | Tabla de parámetros con el tipo, si es obligatorio, el valor predeterminado y los valores aceptados. |
| ¿Qué ocurre de forma predeterminada? | Comportamiento cuando se omite una entrada opcional. |
| ¿Qué se devuelve? | Tipo de retorno, cuerpo de respuesta, salida a archivo, flujo o efecto secundario. |
| ¿Qué puede fallar? | Excepción, error de validación, estado HTTP o modo de fallo operativo. |
| ¿Cómo se usa de forma segura? | Notas sobre seguridad, seguridad en workers, límites de tamaño, rutas, tiempos de espera y gestión de secretos. |
Política de cobertura
Sección titulada «Política de cobertura»Las páginas de referencia están respaldadas por el código fuente. Las API públicas se documentan a partir del código fuente del paquete, los archivos de configuración, las pruebas y los ejemplos. Las clases auxiliares internas solo se documentan cuando un desarrollador de aplicaciones necesita comprender su comportamiento para configurar u operar el paquete.
Preparación para la traducción
Sección titulada «Preparación para la traducción»En las páginas de referencia se prefieren las tablas antes que los párrafos densos. Cada fila debe entenderse de forma independiente, porque la segmentación XLIFF posterior dividirá el contenido por bloque.