Pautas de redacción

1. Número de secciones, pasos y notas

A continuación se recoge el número máximo de secciones y pasos disponibles para la creación de un tutorial. No obstante, los estudios demuestran que, cuanto más cortos sean, mejor. 

Recomendaciones

• Secciones: los tutoriales más eficaces tienen menos de cuatro secciones, pero pueden tener hasta diez.
• Pasos: lo ideal es que cada sección contenga tres pasos y nunca más de cinco. No incluyas todos los pasos en una sola sección.
  
• Notas: un paso no debe incluir más de dos notas.

Consejo: Para obtener más orientación sobre la redacción de secciones, pasos y notas, haz clic en Creación de un tutorial > Tutoriales.

Límite de caracteres

En TBW, cada campo de texto incluye un contador de caracteres para ayudarte a respetar los límites de caracteres siguientes.

2. Títulos y descripciones

Títulos de tutoriales

• Elige un título que explique de qué trata el tutorial.
• Haz que el título resulte fácil de buscar y sea compatible con SEO.
• Comienza el título con un verbo de acción, no con un sustantivo.
  • Ejemplo: Iluminar una foto oscura con una capa de ajuste.
• Evita utilizar las expresiones "cómo" o "aprende a" en los títulos.
• Si mencionas funciones del producto en el título, incluye para qué se usará dicha acción.
  • Ejemplo: Eliminar objetos de una foto con la herramienta Pincel corrector.
• El título no debe superar los 120 caracteres con espacios. Cuantos menos, mejor.
• Opta por un título breve.

Títulos de secciones

• El título de sección debe comenzar con un sustantivo y resumir lo que las personas usuarias lograrán al seguir los pasos de una sección.
  • Ejemplo: Perfeccionamiento de la ilustración
  • El uso del sustantivo se debe a que hay quienes leen los títulos de secciones como si fueran un paso. Al usar un sustantivo en lugar de un verbo, les ayudamos a entender mejor el texto.
• No añadas un punto al final de un título de sección.

Descripciones de tutoriales

• La descripción del tutorial aparece debajo del título del tutorial en la pantalla de inicio. Permite describir el contenido del tutorial y su utilidad.
• Añade un punto al final de la descripción del tutorial.
• Ejemplo: Ajusta el brillo y el contraste para mejorar una fotografía oscura.
  

Descripciones de las secciones

• La descripción de una sección se muestra bajo el título de la sección. Utiliza este campo para explicar lo que la persona aprenderá en esa sección. Recuerda que cuanto más corta sea, mejor.
• Añade un punto al final de la descripción de una sección.
• Ejemplo: Una máscara de capa permite ocultar parte de la capa de una imagen subyacente sin cambiar la capa de la imagen de forma permanente.

3. Elementos de la interfaz de usuario

Cuando creas los pasos, es muy probable que tengas que dirigir a la persona usuaria a alguna herramienta, menú o panel específicos para que pueda completar la tarea. Búscalos en el campo de texto del paso utilizando el símbolo “@” para encontrar en insertar la herramienta o función deseada.

A medida que escribas, se irá mostrando una lista con las funciones o herramientas sugeridas para que puedas seleccionar entre ellas. Una vez seleccionado, el nombre del elemento de la interfaz de usuario se mostrará con un formato diferente al del resto del texto. Esto crea una indicación en forma de cuadro de color azul que sirve como ayuda visual y guía hacia la función o herramienta correcta.

Si no ves la función o herramienta que quieres usar, escribe el nombre de la función sin el símbolo “@”. Para los paneles y comandos de menú, utiliza el símbolo ">" para indicar el flujo de trabajo. Utiliza únicamente el nombre del elemento de la interfaz de usuario que se muestra en el propio producto. Esto no genera una indicación. 

• Ejemplo: Capas > Acciones de capa > Bloquear capa

Si descubres que varias de las herramientas y funciones no están disponibles utilizando el mecanismo de la arroba (“@”), ponte en contacto con el equipo de Operaciones Globales de Aprendizaje.

4. Terminología

Las siguientes tablas incluyen términos clave que, como autor/a, debes conocer y usar.  

Acrónimos

Nombres de las aplicaciones

Sigue estas pautas para mencionar el nombre de una aplicación en un tutorial:

• A menos que se indique expresamente en la columna "Utilizar", no incluyas "Adobe" en el nombre de la aplicación. 
• Menciona Photoshop solo cuando aporte una aclaración necesaria. 
• No incluyas “CC” en el nombre de la aplicación. 
• Si debes usar el nombre de una aplicación, limítate a los nombres que se indican en la columna "Utilizar".

Terminología específica para tutoriales

Según las investigaciones realizadas y las preferencias en materia de terminología, existen expresiones específicas que deben usarse o evitarse. Consulta la lista siguiente y las razones de estas preferencias. Utilizar una terminología uniforme proporciona a las personas usuarias un entorno de aprendizaje más consistente.

5. Puntuación

Utiliza la puntuación correcta. Por ejemplo, añade puntos al final de las descripciones, los pasos y las notas. Los títulos pueden escribirse sin puntos ni signos de puntuación adicionales.

6. Uso de las mayúsculas

Pon en mayúscula la primera letra de todas las oraciones de tu tutorial, incluidos los títulos, las descripciones y los pasos.