Passer au contenu principal

​
Tono y voz

Escriba en un estilo técnico, directo al grano y conciso sin dejar de ser accesible. Priorizar la claridad sobre la formalidad.
  • Utilice voz activa y segunda persona (“tú”)
  • Mantenga las oraciones cortas: una idea por oración
  • Liderar con el objetivo y luego dar instrucciones.
  • Evite palabras de relleno innecesarias
  • Sin coberturas: tenga confianza y sea directo
  • Sin lenguaje de marketing: los médicos informan, no venden

​
Atributos de voz

La voz de la documentación de Primo es siempre clara, segura, estructurada, orientada a la acción y profesional.
AtributoMediosNO significa
BorrarLenguaje sencillo, una idea por frase, sin ambigüedades.Tonto o condescendiente
ConfiadoDeclaraciones directas, sin rodeos ni disculpas.Arrogante o insistente
EstructuradoOrganizado, escaneable, lógicoRígido o robótico
Orientado a la acciónGuía al usuario sobre qué hacer a continuación.Mandando o agresivo
ProfesionalRespeta la experiencia en TI, utiliza terminología correctaLleno de jerga corporativa

​
Configuraciones de tono

Los artículos del centro de ayuda utilizan una formalidad media, una energía media y un alto nivel técnico. Escriba de manera profesional pero conversacional, a un ritmo constante y utilice terminología técnica libremente: los lectores son profesionales de TI.

​
Convenciones de idioma

​
Terminología

Utilice siempre términos exactos del glosario. Nunca sustituya los términos del glosario por sinónimos.
usoevitar
sistema de recursos humanosHRIS
el tableroen Primo, a Primo
gestión de dispositivosMDM (en el primer uso, deletrear)
dispositivomaquina, computadora
inscribirseregistrarse, agregar
Implementación de zero-touchconfiguración automática
incorporación / bajaalternativas ad hoc

​
Referencias de productos

Minimiza las menciones de “en Primo” o “para Primo”. Incluya el nombre del producto únicamente cuando:
  • Distinguir Primo de otro sistema
  • Primera mención en un documento.
  • El contexto no estaría claro sin él.
Evitar: “Navega hasta Primo y haz clic en Configuración”
Prefiere: “Navegar a Configuración” Evitar: “Importar empleados a Primo”
Prefiere: “Importar empleados”

​
Acrónimos

Deletree las siglas cuando las use por primera vez, seguidas de la abreviatura entre paréntesis. Utilice la abreviatura para menciones posteriores. Ejemplo: La administración de dispositivos móviles (MDM) permite la configuración remota. Las políticas de MDM controlan la configuración del dispositivo.

​
Convenciones de estilo

​
Encabezamientos

  • Utilice mayúsculas y minúsculas: “Configure su cuenta”, no “Configure su cuenta”.
  • Utilice verbos imperativos: “Configurar SSO”, no “Configurar SSO”.
  • Mantenga los títulos concisos y orientados a la acción
evitarPrefiero
Configurando tus ajustesConfigurar ajustes
Administrar los dispositivos de los empleadosAdministrar dispositivos
Entendiendo zero-touchComprender zero-touch
Importar mediante CSVImportar vía CSV

​
Formato

  • Negrita para elementos de la interfaz de usuario: haga clic en Configuración > Integraciones
  • Esté atento a ** perdidos: marcadores en negrita que no se cerraron correctamente o que se filtraron de un lapso anterior. Una línea siempre debe tener un número par de marcadores **. Patrones comunes para detectar:
    • ***word** (* extra líder) → **word**
    • **word **other** (marcador abierto anidado) → **word other**
  • Code formatting para:
    • Nombres de archivos: config.json
    • Comandos: mint dev
    • Rutas: /api/employees
    • Referencias de código: deviceId
  • Utilice <Steps> para pasos secuenciales; prefiera esto a las listas numeradas siempre que los pasos sigan un orden definido
  • En los atributos <Step title="...">, no utilice formato de rebajas: la negrita (**) y los enlaces ([text](url)) se representan como caracteres literales en los atributos JSX. Texto sin formato sólo en títulos; use el cuerpo del paso para obtener contenido enriquecido si es necesario
  • Utilice viñetas para elementos no secuenciales
<Steps>
  <Step title="Navigate to Settings > Team">
  </Step>
  <Step title="Click 'Add member'">
  </Step>
  <Step title="Enter one or multiple email address(es) and choose a role">
    To invite multiple members at the same time, you can specify multiple
    emails separated with commas in the 'Email' field.
  </Step>
</Steps>

​
Estructura del artículo

Siga un patrón consistente en todos los artículos:
  1. Título — Verbo imperativo + objeto (p. ej., “Conecta tu sistema de recursos humanos”)
  2. Descripción: resumen de una frase de lo que logrará el lector.
  3. Requisitos previos: enumera los requisitos antes de comenzar (si corresponde)
  4. Pasos: instrucciones numeradas con acciones claras
  5. Próximos pasos: enlace al contenido relacionado (si corresponde)

​
Grupos de tarjetas

Utilice <CardGroup> para mostrar enlaces relacionados como tarjetas visuales. Siga estas pautas:
  • Maximum 3 cards per row — Use cols={3} or fewer for readability
  • Mantenga la copia de la tarjeta sincronizada: los títulos y descripciones de las tarjetas deben coincidir con el texto del artículo al que se hace referencia.
  • Utilice tarjetas para colecciones: lo mejor para páginas de descripción general que enlazan con contenido relacionado
<CardGroup cols={3}>
  <Card title="Connect your HR system" icon="users" href="/es/employees/connect-hris">
    Sync employee data automatically from your HR system.
  </Card>
  <Card title="Import via CSV" icon="file-csv" href="/es/employees/import-via-csv">
    Bulk import employees using a spreadsheet.
  </Card>
  <Card title="Automate onboardings" icon="wand-magic-sparkles" href="/es/employees/automate-onboardings">
    Set up automatic device provisioning for new hires.
  </Card>
</CardGroup>
Mantenimiento: Al actualizar el título o la descripción de un artículo, busque cualquier tarjeta que haga referencia a esa página y actualícela para que coincida.

​
Referencia rápida

ElementoconvenciónEjemplo
EncabezamientosCaso de oración, imperativo”Configurar cifrado de disco”
elementos de la interfaz de usuarioNegritaHaga clic en Guardar
Código/comandoscomillas invertidasEjecute mint dev
Nombre del productoMinimizar el usoOmitir “en Primo” cuando sea obvio
AcrónimosDeletrea el primer uso”Sistema de recursos humanos” no “HRIS”
Card groupsMax 3 columns, synced copy<CardGroup cols={3}>
Pasos secuencialesUtilice <Steps>@@I18N_SEG_117@@<Steps><Step title="...">