Manuales

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

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

todo centrado en un tema específico para las necesidades de una audiencia específica. Si estás tomando un curso de escritura técnica usando este libro, tu proyecto del manual debe incluir de alguna manera cada uno de estos tres elementos. Además, estos elementos deben ser una "combinación" natural y lógica para tu proyecto de manual.

Asegúrate de revisar el ejemplos.

Infografía generada por NotebookLM de este capítulo

Fundamentos del Manual

Conceptos. La información conceptual explica cómo funcionan las cosas, cómo están ensambladas. Para instrucciones más complejas, tienes que conocer algunos conceptos, teorías, antecedentes, principios para realizar las instrucciones. Considera el ejemplo de la función de software que te permite modificar o crear tu propio color. Usar algo como Photoshop, Illustrator, CorelDraw o Paint Shop Pro para hacer esto—los botones y deslizadores— es fácil. Pero entender cómo el matiz, la intensidad, el brillo, la saturación, la densidad, el contraste, RGB— eso es difícil. Tienes que conocer la teoría del color en computadoras 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 caracteres comodín. Realmente no puedes entender cómo usar estos comandos —seguir instrucciones usando ellos —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 empaque de productos, en las guías del usuario que vienen con electrodomésticos y computadoras.

Referencia. La última categoría de información involucra 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 los conceptos de archivos, directorio, comodines primero. Luego podrías seguir y entender las instrucciones sobre cómo 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 que no están cubiertos en la sección de instrucciones o no puedes recordar ciertos procedimientos que se mencionaron en la sección de instrucciones. Ahora es el momento en que necesitas información de referencia básica: solo vas a esa sección y lo buscas 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 —ahí es cuando vas a la sección de referencia. Probablemente podrías arrancar las secciones de conceptos e instrucciones y tirarlas. Todo lo que necesitarás es la sección de referencia.

Formato y Estilo del Manual

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

Prototipo del manual. Desde el enlace a continuación, puedes obtener una versión de prueba del manual. Incluye todas las páginas requeridas en un buen formato. Incluidos en este documento de Word hay estilos de párrafo y de carácter que harán tu trabajo más fácil y añadirán algunas habilidades profesionales a tu repertorio.

Prototipo del manual

Contenido del prototipo. El prototipo para la tabla de contenido es particularmente útil: te da los estilos de Word para producir una tabla de contenido con aspecto profesional. Es difícil conseguir que los alineamientos a la izquierda y a la derecha y los puntos guía estén correctos:

Prototipo de tabla de contenido

Ejemplos de Manual

Aquí hay algunos enlaces a ejemplos de manuales. Ten en cuenta que hay algunos problemas en los ejemplos, problemas de los cuales la mayoría he comentado. Algunos de estos son manuales en la frontera. Lo que hace un manual para mí es la presencia de discusión conceptual, instrucciones e información de referencia.

Asegúrate de revisar el ejemplos.

Prompts de IA para manuales

Listas de verificación, que generalmente no se leen, pueden usarse como fuente para indicaciones de IA con algunas modificaciones. Copie lo siguiente, péguelo en un sistema de IA como Gemini de Google y vea qué puede haber pasado por alto.

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

¡próximamente!

Agradecería tus pensamientos, reacciones y críticas sobre este capítulo: tu respuesta—David McMurrey.