Las abreviaciones incluyen abreviaturas, siglas y acrónimos.
En la documentación, es importante desarrollar el término completo en la primera mención, si este no es ampliamente conocido, y agregar la abreviación entre paréntesis inmediatamente después.
| Correcto ✅ | Incorrecto ❌ |
|---|---|
El componente Filtro se utiliza para filtrar productos en la página de listado de productos (PLP) y en la página de búsqueda. | El componente Filtro se utiliza para filtrar productos en la PLP y en la página de búsqueda. |
Evita usar abreviaturas como "p. ej." (por ejemplo). Utiliza las expresiones completas.
| Correcto ✅ | Incorrecto ❌ |
|---|---|
Especifica el tipo de evento deseado (ejemplo: 'compra'). | Especifica el tipo de evento deseado (p. ej.: 'compra'). |
Uso de puntos en abreviaciones
Las siglas y acrónimos no llevan puntos.
| Correcto ✅ | Incorrecto ❌ |
|---|---|
|
|
Las abreviaturas, que son formas reducidas de una sola palabra, sí llevan punto al final.
| Correcto ✅ | Incorrecto ❌ |
|---|---|
|
|
Acrónimos
Respecto a las mayúsculas de acrónimos, sigue el formato estándar usado en la industria Es muy común que los acrónimos se utilicen en inglés. Si este es el caso y tienes que desarrollarlo, utiliza las mayúsculas del inglés.
| Correcto ✅ | Incorrecto ❌ |
|---|---|
|
|
No desarrolles acrónimos comunes.
| Correcto ✅ | Incorrecto ❌ |
|---|---|
|
|
Evita crear acrónimos con los nombres de productos o funcionalidades.
| Correcto ✅ | Incorrecto ❌ |
|---|---|
|
|
Utiliza artículo masculino o femenino dependiendo de la convención en español. Si se utilizan ambas formas, consulta la convención en el glosario VTEX.
| Correcto ✅ | Incorrecto ❌ |
|---|---|
|
|
Usa acrónimos en mayúsculas para los formatos de archivo y escribe las extensiones en minúsculas (por ejemplo: faststore.config.js).
| Correcto ✅ | Incorrecto ❌ |
|---|---|
|
|
En español, las siglas no utilizan la 's' para formar el plural. Sin embargo, en textos tecnológicos y en elementos de interfaz de usuario, es aceptable agregar una "s" para marcar el plural y evitar ambigüedades.
Ejemplos
| Correcto ✅ | Incorrecto ❌ |
|---|---|
|
|