Nota:
- Este capítulo, así como el resto del libro de Redacción Técnica, se enfoca en las habilidades de redacción técnica. No se garantiza que el contenido técnico aquí presentado sea exitoso, preciso o esté actualizado.
- Este capítulo fue traducido utilizando OpenAI ChatGPT. Por favor, informe cualquier problema lingüístico a admin@mcmassociates.io.
- El texto en las imágenes de esta página se traducirá lo antes posible.
- Haga clic aquí para ayudar a David McMurrey a pagar el alojamiento web: ¡Done cualquier cantidad! Online Technical Writing seguirá siendo gratuito.
Por favor, haga clic aquí para ayudar. David McMurrey pagar por alojamiento web:
Dona cualquier pequeña cantidad que puedas
La redacción técnica en línea seguirá siendo gratuita.
Esta página está en reparación.
Infografía generada por NotebookLLM de este capítulo
Mensaje de transmisión
Párrafo final. Anima 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 el manual de usuario satisfactorio.
Al igual que con cualquier otro elemento en una guía del usuario, es posible que tenga que modificar el contenido de este mensaje (o memorando) para situaciones específicas. Por ejemplo, puede que quiera añadir otro párrafo, enumerando preguntas que le gustaría que los lectores consideraran mientras revisan la guía del usuario.
-->
Portada y contraportada
Página de título
Aviso de edición, Derechos de autor, Marcas registradas
Tabla de contenidos
Prefacio
Capítulos principales de la guía del usuario
Apéndices
Apéndices
Índice
Otros elementos de la guía del usuario
Encabezados
Listas con viñetas y numeradas
Símbolos, números y abreviaturas
Gráficos y títulos de figuras
Referencias cruzadas
Numeración de páginas
Indicaciones de IA para guías de usuario
Las listas de verificación, que normalmente no se leen, pueden utilizarse 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é pudo haber pasado por alto.
Nota: Todas las referencias al contenido, formato, estilo de las guías de usuario o de sus componentes se pueden encontrar en el libro de texto en línea sobre redacción técnica.
Cuando quieras usar la IA para evaluar un proyecto de escritura, preséntate, dile a la IA quién eres y qué quieres. Proporciónale a la IA un punto de referencia para realizar las evaluaciones, como un libro de texto en línea. Luego publica lo que quieres que la IA revise en su evaluación.
Modifica la introducción para que se ajuste a tu identidad.
|
Guías de usuario de indicaciones para IA
Hola, IA. Solicito que evalúes las instrucciones escritas por un estudiante de segundo año de una universidad de Estados Unidos. A continuación hay un resumen de capítulos de libros de texto sobre instrucciones y avisos para usar como base de su evaluación. (Información de identificación enmascarada):
¿Contiene la guía del usuario lo siguiente (formateado correctamente) en este orden: mensaje de remisión, portada y contraportada, página del título; aviso de edición, tabla de contenidos; prefacio; capítulos, apéndices (según sea necesario); índice, contraportada?
Si bien puede ser ingenioso y juguetón, ¿indica adecuadamente el título de la guía del usuario su tema? Para más detalles, consulte títulos de la guía del usuario.
Si la tabla de contenidos y la lista de figuras (y tabla) usan puntos de relleno, ¿los números de página están alineados a la derecha? Si la tabla de contenidos y la lista de figuras (y tabla) incluyen números de página en el borde derecho de la página, ¿se usan puntos de relleno? Para más detalles, consulte Tablas de contenidos y lista de figuras (tablas).
¿La introducción indica adecuadamente el tema, el propósito y el público previsto de la guía del usuario? ¿Proporciona una lista de subtemas que se tratarán y una indicación de
alcance (lo que no se cubre)? Para más detalles, consulte Introducciones.
¿Contiene esta guía del usuario detalles adecuados, especificaciones, ejemplos—todo lo que sea necesario para explicar las afirmaciones, las generalidades?
Teniendo en cuenta el tema, el propósito y la audiencia, ¿faltan contenidos vitales en esta guía del usuario? ¿Hay algún contenido innecesario? ¿Alguna información de esta guía del usuario es técnicamente incorrecta? ¿Falta alguna información técnica crítica?
¿Contiene esta guía del usuario alguna información claramente tomada de otra fuente que no esté documentada de ninguna manera?
¿Las citas (referencias a elementos en la lista de fuentes de información) aparecen en el cuerpo de la guía del usuario formateadas según el estilo APA, MLA o IEEE modificado? ¿Los elementos en la lista de fuentes de información están formateados según el estilo APA, MLA o IEEE modificado? Para más detalles, consulte Documentación: fuentes de información prestadas.
¿Todas las tablas y las figuras no decorativas incluyen un título descriptivo (leyenda) y la fuente (si procede)? Para más detalles, consulte Títulos de tabla.
¿Aparecen todas las tablas y figuras no decorativas lo más cerca posible del texto relevante?
¿Aparecen breves referencias cruzadas explicativas antes de las tablas y las figuras no decorativas? Para más detalles, consulte Referencias cruzadas explicativas.
¿Se utiliza un formato estándar de encabezados y subencabezados en el cuerpo de la guía del usuario? Para más detalles, consulte Encabezados.
¿Las secciones principales (capítulos) de la guía del usuario comienzan en una nueva página en las versiones impresas?
¿Se usan listas verticales numeradas para elementos de lista en un orden requerido? ¿Se usan listas verticales con viñetas para elementos de lista sin un orden requerido? ¿Se utilizan líneas introductorias antes de todas las listas? Para más detalles, consulte Listas verticales.
¿Se atribuyen las citas textuales y están las atribuciones correctamente puntuadas? ¿Están todas las citas textuales, los resúmenes y las paráfrasis debidamente citados según APA, MLA o el estilo IEEE modificado? Para más detalles, vea Citas y atribuciones.
¿El texto de la guía del usuario está libre de errores de gramática, uso y puntuación? Para más detalles, consulte Problemas comunes de gramática, uso y ortografía.
¿El texto de la guía del usuario está libre de verborrea y de otros errores de estilo en las oraciones? Para más detalles, consulte Verbosidad, otros problemas de estilo de la oración.
¿Puede esta guía del usuario ser entendida por su público objetivo (como se indica en el mensaje de remisión y la introducción)? Para más detalles, consulte Análisis de audiencia, y ver Traduciendo lo técnico.
AT, para completar su evaluación de mi guía de usuario, asigne una calificación numérica de 100 a 55).
|
Información relacionada
Cómo escribir temas de ayuda amigables para principiantes. clickhelp.com
Cómo escribir documentación de usuario. escriba tecnológico
Guías de usuario. escriba técnico
Agradecería sus pensamientos, reacciones y críticas con respecto a este capítulo:
tu respuesta—David McMurrey.
