Haz clic aquí para ayudar a David McMurrey a pagar el alojamiento web:
Dona cualquier pequeña cantidad que puedas
La escritura técnica en línea seguirá siendo gratuita.
Esta página está en reparación.
Los documentos técnicos (incluidos manuales, documentos técnicos y guías) tienen diversos diseños según la industria, la profesión o la organización. Este capítulo te muestra un diseño tradicional. Si estás tomando un curso de redacción técnica, asegúrate de que el diseño presentado en este capítulo sea aceptable. Lo mismo es válido si estás redactando un documento técnico en un contexto científico, empresarial o gubernamental.
Infografía de este capítulo generada por NotebookLLM
Nota: Durante años, este libro de texto en línea de redacción técnica se refirió genéricamente a los informes como prácticamente cualquier cosa que contuviera información técnica. Pero debido a que “informe” se refiere a un género específico de documento técnico, fue necesario cambiar al término genérico “guía del usuario”, abreviatura de documento técnico.
Las guías del usuario (nombre genérico de los documentos técnicos) tienen especificaciones como cualquier otro tipo de proyecto. Las especificaciones para las guías del usuario incluyen el diseño, la organización y el contenido, el formato de encabezados y listas, el diseño de los gráficos, etc. La ventaja de una estructura y un formato requeridos es que tú u otras personas pueden esperar que estén diseñadas de una manera familiar: sabes qué buscar y dónde buscarlo. Las guías del usuario suelen leerse con prisa; las personas quieren llegar rápidamente a la información que necesitan, a los datos clave, las conclusiones y otros elementos esenciales. Un formato estándar de guía del usuario es como un vecindario familiar.
Cuando analices el diseño de una guía del usuario, observa cuán repetitivas son algunas secciones. Esta duplicación tiene que ver con la forma en que las personas leen las guías del usuario. No las leen de principio a fin: pueden comenzar con el resumen ejecutivo, saltar de un lugar a otro y probablemente no leer todas las páginas. Tu reto es diseñar guías del usuario de modo que estos lectores se encuentren con tus datos clave y conclusiones, sin importar cuánto lean ni en qué orden lo hagan.
Asegúrate de ver los ejemplos de guías del usuario.
Los componentes estándar del informe técnico típico se analizan en este capítulo. Las siguientes secciones te guían a través de cada uno de estos componentes, señalando sus características clave. Al leer y usar estas pautas, recuerda que son pautas, no mandamientos. Diferentes empresas, profesiones y organizaciones tienen sus propias directrices para las guías del usuario; tendrás que adaptar tu práctica tanto a esas como a las presentadas aquí.
Mensaje de envío
El mensaje de envío puede ser una carta de presentación (o memorando) o un correo electrónico. La carta física (o memorando) se adjunta al exterior de la guía del usuario con un clip o se encuaderna dentro de ella. El correo electrónico contiene un enlace a la guía del usuario o la guía adjunta. Es una comunicación de ti —el redactor de la guía— al destinatario, la persona que solicitó la guía y que incluso puede estar pagándote por tu consultoría experta. Básicamente dice: “Bien, aquí está la guía del usuario que acordamos que completaría para tal fecha. En resumen, contiene esto y aquello, pero no cubre esto otro. Avísame si satisface tus necesidades”. El mensaje de envío explica el contexto: los acontecimientos que dieron origen a la guía del usuario. Contiene información sobre la guía que no pertenece dentro de la guía misma.
Ejemplos de una carta de envío y un mensaje de envío.
En el ejemplo de la carta de envío, observa el formato estándar de carta comercial. Si redactas una guía del usuario interna, utiliza el formato de memorando; en ambos casos, el contenido y la organización son los mismos:
Primer párrafo. Cita el nombre de la guía del usuario, colocándolo en cursiva. También menciona la fecha del acuerdo para redactar la guía.
Párrafo intermedio. Se centra en el propósito de la guía del usuario y ofrece una breve descripción general de su contenido.
Párrafo final. Invita al lector a ponerse en contacto si tiene preguntas, comentarios o inquietudes. Cierra con un gesto de buena voluntad, expresando la esperanza de que el lector encuentre satisfactoria la guía del usuario.
Como con cualquier otro elemento de una guía del usuario, es posible que debas modificar el contenido de este mensaje (o memorando) para situaciones específicas. Por ejemplo, podrías querer añadir otro párrafo con preguntas que deseas que los lectores consideren al revisar la guía.
Indicaciones de IA para guías del usuario
Las listas de verificación, que normalmente no se leen, pueden utilizarse como fuente para indicaciones de IA con algunas modificaciones. Copia lo siguiente, pégalo en un sistema de IA como Gemini de Google y observa qué podrías haber pasado por alto.
Nota: Todas las referencias al contenido, formato y estilo de los informes de datos o de sus componentes se pueden encontrar en el libro de texto de redacción técnica en línea.
| Indicaciones de IA para guías del usuario |
|
