Guía de estilo general

El repositorio contempla buenas prácticas para continuar con el flujo de trabajo e incorporación de mejoras, las cuales son las siguiente:

• Usa el formato Markdown (.md) con sintaxis clara y correcta
• Escribe en español neutro, guiandote del estilo del repositorio
• Mantén la estructura de la documentación según el marco Diátaxis
• Si agregas archivos, usa nombres en minúsculas y con guiones medios, sin acentos ni caracteres especiales
• Usar camelcase en caso de utilizar código.
• Al contribuir contenido nuevo, define si es un tutorial, how-to, explainer o referencia
• Si adaptas contenido de terceros, incluye siempre la fuente y el enlace original

Para resaltar elementos informativos, de advertencia, de error o de importancia legal se utilizarán bloques como los siguientes:

!!! success "Buenas Prácticas" 
    El bloque de confirmación (verde) sirve para distinguir las buenas prácticas.

Buenas Prácticas

El bloque de confirmación (verde) sirve para distinguir las buenas prácticas.

!!! warning "Alternativa"
    El bloque de advertencia (amarillo) sirve para mencionar otra manera de hacer las cosas (esto es especialmente útil para los how-to).

Alternativa

El bloque de advertencia (amarillo) sirve para mencionar otra manera de hacer las cosas (esto es especialmente útil para los how-to).

!!! failure "Error"
    El bloque de error (rojo) sirve para explicar qué otro camino seguir si se encuentra un error, o cómo solucionar un posible error.

Error

El bloque de error (rojo) sirve para explicar qué otro camino seguir si se encuentra un error, o cómo solucionar un posible error.

!!! abstract "Consideración Legal"
    El bloque de información (azul) se utiliza para resaltar consideraciones legales

Consideración Legal

El bloque de información (azul) se utiliza para resaltar consideraciones legales

Consideraciones adicionales para el idioma español

Para la escritura de documentos en el presente repositorio se sugiere apegarse a los siguientes lineamientos de estilo:

• Utilizar el lenguaje descriptivo markdown para la escritura de los documentos
• Evitar utilizar palabras en inglés que sí tienen traducción al español. Por ejemplo, no utilizar app sino aplicación. Por cuestiones de claridad, algunos términos pueden mantenerse en inglés.
• Utilizar el impersonal. En los casos que sea imposible, se puede utilizar la segunda persona del plural.
• Las páginas deben tener nombres de ruta en minúsculas y con guión medio. No se deben utilizar caracteres especiales como acentos u otros símbolos.