\n

Cada tipo de lista tiene una función relevante dentro del technical writing. Estas nos ayudan a que los lectores logren comprender, memorizar y revisar los puntos clave del tema en cuestión, seguir una secuencia de acciones o instrucciones y, además, separa los largos tramos de texto y los separa en frases cortas, así como lo estudiamos en la clase de cómo escribir con claridad.

\n

Sin embargo, a pesar de la diversidad de tipos de listas que existen, todas deben cumplir algunos lineamientos generales, los cuales mencionaré en el siguiente punto.

\n

Lineamientos generales de las listas 📚

\n

En contextos de technical writing, debes utilizar un estilo específico de listas, como el que te presento aquí:

\n

Utiliza las listas para resaltar o enfatizar el texto o para enumerar elementos secuenciales.
Usa espaciado, indentación y puntuación en cada frase.
Haz que los elementos de la lista sean paralelos en la redacción.
Asegúrate de que cada elemento enlistado tenga que ver con el enfoque de la lista.
Utiliza una introducción para presentar los elementos de la lista y para indicar el significado o propósito de esta (y puntuar con dos puntos).
Evita el uso excesivo de listas; el uso de demasiadas listas destruye su eficacia.
Puedes aprovechar la función “estilos” o “formatos” de tu software para crear listas verticales en lugar de construirlas manualmente.

\n

Elige el tipo de lista correcto 👍

\n

Los siguientes tipos de listas dominan en la escritura técnica:

\n

Listas con viñetas
Listas numeradas
Listas incrustadas o embebidas

\n

Utiliza una lista con viñetas para los artículos no ordenados. Y utiliza una lista numerada para los artículos ordenados. En otras palabras:

\n

Si reorganizas los artículos de una lista con viñetas, el significado de la lista no cambia.
Si reorganizas los artículos de una lista numerada, el significado de la lista cambia.

\n

Por ejemplo, hemos hecho la siguiente lista con viñetas, la cual al reorganizar sus elementos no cambia el significado de la lista:

\n

Javascript es un lenguaje poderoso, sus usos más importantes son los siguientes:\n\n- Desarrollo de sitios web del lado del cliente (frontend, en el navegador).\n- Desarrollo de todo tipo de aplicaciones gracias a la plataforma NodeJS.\n- Desarrollo de aplicaciones para dispositivos móviles, híbridas o que compilan a nativo.\n

\n

La siguiente lista, por el contrario, debe ser una lista numerada, ya que si cambiáramos el orden de sus elementos, también cambiaría el significado de la lista:

\n

Configurar una cuenta de GitHub:\n\n1. Vaya a https://github.com/join.\n2. Escriba un nombre de usuario, su dirección de correo electrónico y una contraseña.\n3. Elija Sign up for GitHub y siga las instrucciones.\n

\n

Una lista embebida contiene varios elementos dentro de una frase. Por ejemplo, la siguiente frase contiene una lista embebida con siete elementos:

\n

CodeDeploy puede implementar una variedad de contenidos de aplicación prácticamente ilimitada, entre las que se incluyen código, funciones AWS Lambda sin servidor, archivos de configuración y web, ejecutables, paquetes, scripts y archivos multimedia.\n

\n

En términos generales, las listas embebidas son una forma inadecuada de presentar información técnica. Lo adecuado es transformar las listas embebidas en listas con viñetas o listas numeradas. Veamos cómo quedaría la frase embebida presentada en el párrafo anterior a manera de lista con viñetas:

\n