Saltar al contenido principal
LibreTexts Español

2.10: Manuales

  1. Última actualización
  2. Guardar como PDF
  • Page ID
    103270

    • \( \newcommand{\vecs}[1]{\overset { \scriptstyle \rightharpoonup} {\mathbf{#1}} } \) \( \newcommand{\vecd}[1]{\overset{-\!-\!\rightharpoonup}{\vphantom{a}\smash {#1}}} \)\(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\) \(\newcommand{\id}{\mathrm{id}}\) \( \newcommand{\Span}{\mathrm{span}}\) \( \newcommand{\kernel}{\mathrm{null}\,}\) \( \newcommand{\range}{\mathrm{range}\,}\) \( \newcommand{\RealPart}{\mathrm{Re}}\) \( \newcommand{\ImaginaryPart}{\mathrm{Im}}\) \( \newcommand{\Argument}{\mathrm{Arg}}\) \( \newcommand{\norm}[1]{\| #1 \|}\) \( \newcommand{\inner}[2]{\langle #1, #2 \rangle}\) \( \newcommand{\Span}{\mathrm{span}}\)\(\newcommand{\AA}{\unicode[.8,0]{x212B}}\)

    Objetivos de Inclinación

    Al finalizar este capítulo, los lectores podrán:

    1. Explique los tres tipos de información que se encuentran en los manuales.
    2. Explicar y aplicar las pautas para el formato y estilo del manual.

    Un manual, tal como lo estamos definiendo aquí, es una combinación de concepto, instrucción e información de referencia enfocada en un tema específico para las necesidades de una audiencia específica.

    Conceptos básicos del manual

    Conceptos

    La información conceptual explica cómo funcionan las cosas, cómo se juntan las cosas. Para instrucciones más complejas, hay que conocer algunos conceptos, teoría, antecedentes y 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, Ilustración, CorelDRAW o Paint Shop Pro para hacer esto, los botones y controles deslizantes reales, es fácil. Pero entender cómo funcionan el tono, la intensidad, el brillo, la saturación, la densidad, el contraste y el 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 Linux: ls, cd, cp, mv, pwd. Para usar estos comandos, es necesario entender qué son los archivos y directorios, y probablemente qué es un sistema operativo así como los comodines. Realmente no puedes entender cómo usar estos comandos, sigue las instrucciones para usarlos, a menos que entiendas estos conceptos básicos.

    Instrucciones

    Si entiendes los conceptos fundamentales, entonces puedes seguir inteligentemente los procedimientos paso a paso. Las instrucciones son esas cosas familiares de la lista numerada que le guían cuidadosamente a través de un procedimiento. Las instrucciones están en todas partes, en el empaque del producto, en las guías de usuario que vienen con electrodomésticos y en computadoras.

    Referencia

    La última categoría de información implica información de búsqueda, o información de referencia rápida. Si seguiste el ejemplo del sistema de archivos anterior, primero tenías que estudiar y aprender los conceptos de archivos, directorio y comodines. Entonces podrías seguir y entender las instrucciones sobre cómo cambiar directorios, copiar, eliminar o mover archivos. 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 instrucción o no puedes recordar ciertos procedimientos que fueron cubiertos en la sección de instrucción. Ahora es el momento en que necesitas información básica de referencia: solo tienes que ir a esa sección y buscarla rápidamente.

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

    Formato y estilo del manual

    Al crear un manual, debe cumplir con pautas bastante específicas para el uso de encabezados, listas, avisos, gráficos, tablas, documentación e introducciones, que por supuesto supone que debe usar estas cosas:

    Prototipo manual

    Desde el siguiente enlace puedes obtener una versión ficticia del manual. Incluye todas las páginas requeridas en buen formato. En este documento de Word se incluyen estilos de párrafo y carácter que facilitarán tu trabajo y agregarán algunas habilidades profesionales a tu repertorio.

    Prototipo manual

    Prototipo de contenidos

    El prototipo para la tabla de contenido es particularmente útil: te da los estilos de Word para producir un TOC de búsqueda profesional. Es difícil conseguir las alineaciones izquierda y derecha y los puntos de líder a la derecha.

    Prototipo de tabla de contenido.

    En realidad, estos mismos prototipos pueden ser utilizados para cualquier reporte formal.

    This page titled 2.10: Manuales is shared under a CC BY license and was authored, remixed, and/or curated by Tiffani Reardon, Tammy Powell, Jonathan Arnett, Monique Logan, & Cassie Race.