Componentes

Presente instrucciones ordenadas en pasos claros y numerados para que los lectores puedan seguir un proceso de principio a fin.

Destaque notas importantes, advertencias, consejos o guías contextuales sin interrumpir la documentación circundante.

Muestra un ejemplo de código enfocado y con sintaxis resaltada con una acción de copia para una implementación rápida.

Agrupe los ejemplos de código relacionados en pestañas de lenguajes o frameworks para que los desarrolladores puedan elegir el ejemplo que mejor se adapte a su entorno tecnológico.

Organice las preguntas y respuestas relacionadas en filas desplegables para que las páginas de documentación extensas sean fáciles de explorar.

Presente información estructurada en filas y columnas para una rápida comparación, referencia o consulta de configuración.

Explique sistemas, flujos de trabajo y relaciones con diagramas visuales claros integrados directamente en su documentación.

Muestre datos anidados, estructuras de archivos o jerarquías en un formato de árbol desplegable fácil de leer.

Comparte un prompt reutilizable con una acción de copia dedicada, ayudando a los lectores a pasar rápidamente de la documentación a la experimentación.

Documente un campo, parámetro o propiedad de objeto con su tipo y estado obligatorio en un formato de referencia consistente.

Agregue imágenes adaptables con contexto útil para ilustrar conceptos, resultados, interfaces o flujos de trabajo visuales.

Inserta contenido de video para demostrar un flujo de trabajo, explicar una función o proporcionar una guía visual junto con la documentación.

Inserta una publicación de X para incluir actualizaciones de productos, ejemplos o conversaciones de la comunidad directamente en la documentación.

Inserta un video de YouTube para tutoriales, demostraciones de productos y contenido educativo de formato más largo.

Inserta un video de Vimeo manteniendo la presentación visual coherente con el resto de tu documentación.

Inserta un archivo de audio para guías de voz, grabaciones o material de apoyo para escuchar.

Inserta una animación Lottie para añadir un movimiento ligero y pulido que ayude a explicar una función o interacción.

Incrusta código externo o ejemplos interactivos cuando un bloque de código estándar no sea suficiente para la documentación.