Manuales

Un manual, tal como lo estamos definiendo aquí, es una combinación de lo siguiente:

• concepto información
• instrucción información
• información de referencia

todos centrados en un tema específico para las necesidades de una audiencia específica. Si estás tomando un curso de redacción técnica que utiliza este libro, tu proyecto de manual debe Incluye de alguna manera cada uno de estos tres elementos. Además, estos elementos deberían ser un "encaje" natural y lógico para tu proyecto de manual.

Asegúrate de echar un vistazo a ejemplos.

Infografía generada por NotebookLM de este capítulo

Conceptos básicos del manual

Conceptos. La información conceptual explica cómo funcionan las cosas, cómo están compuestas. Para instrucciones más complejas, tienes que conocer algunos conceptos, teoría, antecedentes y principios para llevar a cabo las instrucciones. Considera el ejemplo de la función del software que te permite modificar o crear tu propio color. Usar algo como Photoshop, Illustration, CorelDraw o Paint Shop Pro para hacer esto—los botones y deslizadores reales— es fácil. Pero entender cómo el tono, la intensidad, el brillo, la saturación, la densidad, el contraste, RGB—eso es difícil. Tienes que conocer la teoría del color por computadora para crear el color que necesitas.

Considera otro ejemplo: comandos simples del sistema de archivos de Linux—ls, cd, cp, mv, pwd. Para usar estos comandos, necesitas entender qué son los archivos y los directorios, y probablemente qué es un sistema operativo, así como los comodines. Realmente no puedes entender cómo usar estos comandos—seguir instrucciones usándolos—a menos que entiendas estos conceptos básicos.

Instrucciones. Si entiendes los conceptos fundamentales, entonces puedes seguir de manera inteligente los procedimientos paso a paso. Las instrucciones son esas cosas familiares en forma de lista numerada que te guían cuidadosamente a través de un procedimiento. Las instrucciones están en todas partes: en el embalaje de los productos, en las guías de usuario que vienen con electrodomésticos y computadoras.

Referencia. La última categoría de información implica información de consulta, o información de referencia rápida. Si seguiste el ejemplo del sistema de archivos anterior, tuviste que estudiar y aprender primero los conceptos de archivos, directorios y comodines. Entonces pudiste seguir y entender las instrucciones sobre cambiar de directorio, copiar, eliminar o mover archivos. Sin embargo, después de un tiempo ya no necesitas las instrucciones, pero de vez en cuando tienes requisitos especiales no cubiertos en la sección de instrucciones o no puedes recordar ciertos procedimientos que sí se trataron en esa sección. Entonces es cuando necesitas información básica de referencia: simplemente vas a esa sección y la consultas rápidamente.

Y así, después de más tiempo, ya no necesitas ni la sección de conceptos ni la sección de instrucciones: te has acostumbrado tanto a esos procedimientos que los conoces de memoria. Pero de vez en cuando olvidas algún pequeño detalle o tienes alguna tarea especial que nunca has hecho antes — es entonces cuando acudes a la sección de referencia. Probablemente podrías arrancar las secciones de conceptos y de instrucciones y desecharlas. Todo lo que necesitarás alguna vez será la sección de referencia.

Formato y estilo del manual

En un curso de redacción técnica que utilice este libro, puede esperarse que utilice las pautas específicas para el uso de encabezados, listas, avisos, gráficos, tablas, documentación e introducciones:

Prototipo del manual. Desde el enlace de abajo puedes obtener una versión de muestra del manual. Incluye todas las páginas requeridas en un formato adecuado. En este documento de Word se incluyen estilos de párrafo y de carácter que facilitarán tu trabajo y añadirán algunas habilidades profesionales a tu repertorio.

Prototipo de manual

Prototipo de contenidos. El prototipo de la tabla de contenidos resulta especialmente útil: te proporciona los estilos de Word necesarios para obtener una tabla de contenidos de aspecto profesional. Es difícil conseguir bien las alineaciones a la izquierda y a la derecha y los puntos de relleno:

Prototipo de tabla de contenidos

Ejemplos del manual

Aquí tienes algunos enlaces a ejemplos de manuales. Ten en cuenta que hay algunos problemas en los ejemplos; la mayoría de ellos los he comentado. Algunos de estos están en el límite de ser considerados manuales. Para mí, lo que define un manual es la presencia de discusión conceptual, instrucciones e información de referencia.

Asegúrate de echarle un vistazo a ejemplos.

Sugerencias de IA para manuales

Las listas de verificación, que normalmente no se leen, pueden usarse como fuente para indicaciones de IA con algunas modificaciones. Copia lo siguiente, pégalo en un sistema de IA como Gemini de Google y comprueba lo que podrías haber pasado por alto.

Nota: Todas las referencias al contenido, formato, estilo de techdocs o de sus componentes se pueden encontrar en el libro de texto en línea sobre redacción técnica.

¡Próximamente!

Agradecería sus opiniones, reacciones y críticas con respecto a este capítulo: tu respuesta—David McMurrey.