Consejos de redacción para guías de instalación

Describe pautas de redacción para Partners que envían integraciones

Si no puedes consultar una guía de estilo completa, revisa estos consejos para mejorar notablemente tu contenido.

​

Usa la voz activa

Evita la voz pasiva (verbo to be + participio pasado). Para que el texto sea más dinámico, claro y, a menudo, más breve, procura usar un sujeto explícito y la voz activa siempre que sea posible.

Preferido	Desaconsejado
Una vez que agregues la configuración requerida, Auth0 procesará todos los inicios de sesión de tu inquilino con esta Rule. Antes de activar la integración en producción, asegúrate de haber configurado correctamente todos los componentes y de haberlo verificado en un inquilino de prueba.	Una vez agregada la configuración requerida, todos los inicios de sesión de tu inquilino serán procesados por esta Rule. Asegúrate de que todos los componentes se hayan configurado correctamente y se hayan verificado en un inquilino de prueba antes de activar la integración en producción.

​

Haga que los títulos de los enlaces sean fáciles de leer de un vistazo

Cuando enlace a otros recursos, asegúrese de que el enlace describa la acción o tarea del documento al que apunta. Un texto de enlace genérico dificulta leer el contenido de un vistazo, porque obliga a los lectores a revisar todo el texto que rodea al enlace para identificar qué deben seleccionar.

Preferido	Desaconsejado
Puede usar Auth0 Dashboard o Management API para personalizar el texto de la experiencia de Universal Login.	Haga clic aquí.
Para obtener información sobre cómo asignar roles a miembros de organizaciones, lea Agregar roles a miembros de la organización.	Puede ir a este enlace.

​

Redacte instrucciones independientes del dispositivo

Recuerde que las interfaces de usuario se muestran de manera diferente en distintos dispositivos. Además, recuerde que los usuarios pueden estar usando dispositivos de asistencia para ver su contenido.

Preferible	Desaconsejado
Seleccione Create.	Haga clic en Create.
Cambie a la vista Applications.	Cambie a la pestaña Applications.
Ubique Secreto del cliente.	Desplácese hacia arriba hasta Secreto del cliente.

​

Usa correctamente los verbos y los sustantivos/adjetivos

Ten cuidado con las palabras que pueden usarse como verbos y también como sustantivos o adjetivos. Las formas verbales suelen requerir un espacio entre palabras, mientras que los sustantivos y los adjetivos pueden escribirse como una sola palabra.

Preferido	Desaconsejado
Log in to your account.	Login to your account.
Auth0 processes logins.	Auth0 processes log ins.
Set up your hardware.	Setup your hardware.
Describe your hardware setup.	Describe your hardware set up.

​

Usa mayúsculas solo en la primera palabra de los encabezados

Escribe con mayúscula solo la primera palabra y cualquier nombre propio o nombre de producto de Auth0.

Preferido	Desaconsejado
Añade una dependencia	Añade una Dependencia
Valida el inicio de sesión reanudado	Valida el Inicio de Sesión Reanudado
Crea una Action	Crea una action

​

Usa tiempos simples en los encabezados

Evita los rodeos innecesarios usando tiempos simples en los encabezados.

Preferido	Desaconsejado
Asignar y cambiar usuarios	Asignando y cambiando usuarios
Conectar una base de datos personalizada	Cómo conectar una base de datos personalizada

​

Redacta los pasos de forma concisa

Al escribir el texto introductorio de los pasos, sé directo y conciso. Recuerda que los usuarios ya saben qué deben hacer con una lista numerada de pasos.

Recomendado	Desaconsejado
Para instalar el SDK:	Sigue los pasos a continuación:

​

Establezca las expectativas de los usuarios en los pasos

Indique a los usuarios cuál será el resultado de su acción antes de describir la acción que deben realizar.

Recomendado	Desaconsejado
Para activar esta integración, seleccione Save Changes.	Seleccione Save Changes para activar esta integración.

​

Enumere las acciones dentro de los pasos en orden

Dentro de cada paso, indique al usuario qué debe hacer en el orden en que debe hacerlo.

Preferible	Desaconsejado
Busque la sección Integrations y seleccione Add Integration.	Seleccione Add Integration en la sección Integrations.

​

Usa las notas y las advertencias adecuadamente

Las notas y las advertencias tienen funciones diferentes. Las notas deben incluir información general que sea útil conocer, mientras que las advertencias contienen información cuyo incumplimiento puede provocar errores.

Si corresponde presentar información como advertencia, debes incluirla exactamente donde el usuario deba realizar la acción relacionada. Los usuarios no deberían tener que andar buscando las advertencias.

​

Más información

• Partners del Marketplace
• Actions de redirección para partners
• Conexiones sociales para partners
• Integraciones de SSO para partners