- 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 su factura de alojamiento web:
¡Dona cualquier cantidad pequeña que puedas!
La redacción técnica en línea seguirá siendo gratuita.
Redacción del título
Los títulos de documentos extensos, como documentos técnicos formales, guías de usuario e informes técnicos, a veces son demasiado breves. Por ejemplo, si el título de un documento técnico fuera "Informe sobre la contaminación por plástico", el documento podría superar las 300 páginas. Si fuera "Evaluación de métodos de reciclaje del plástico", el documento podría ser más manejable.
Por supuesto, no quieres que un documento tenga un título como el que John Milton, el poeta inglés, compuso en 1641: Sobre la reforma de la disciplina eclesiástica en Inglaterra: y las causas que hasta ahora la han impedido. Dos libros, escritos a un amigo.
¡Solo piensa en todas las cosas que podrías decir sobre cada uno de estos temas! También es importante el hecho de que los lectores simplemente no van a saber, por títulos así, qué es lo que realmente vas a cubrir.
Elementos de la redacción de títulos
Cuando redactes un título para tu documento, considera indicar estos elementos, pero sin crear un título que sea un párrafo largo:
- Tema: El tema de su documento puede ser similar a los ejemplos anteriores. Pero no se detenga ahí—tiene más trabajo que hacer.
- Alcance: El alcance se refiere a qué tan amplio o qué tan estrecho será su enfoque sobre el tema. El alcance y la visión general no siempre son fáciles de distinguir. El elemento visión general indica una revisión general de algún aspecto del tema.
- Resumen: Tal como se utiliza el término aquí, visión general se refiere a una enumeración de los principales subtemas que se cubrirán. Es cierto que es contradictorio con la forma en que se utiliza el término para definir el alcance. No se preocupe—esto no es ciencia. Un buen ejemplo de este uso del término es el siguiente: Ébola: Transmisión, Síntomas, Tratamiento. Las tres últimas palabras son la enumeración.
Observe que el proceso de crear un título específico y enfocado es similar al proceso de acotar un tema, cubierto en otra parte.
Ejemplos de redacción de títulos
Considera este título: Nanotecnología: Visión general de las aplicaciones médicas. El tema gigante nanotecnología Se afirma, efectivamente, pero observe que se reduce a aplicaciones médicas y se aplica un elemento de alcance—Descripción general.
Observe el uso de los dos puntos en el ejemplo anterior. Le permite reducir la cantidad de palabras. Otra posibilidad es Aplicaciones médicas de la nanotecnología: Visión general.
Redacción del título del problema
Un problema común con los documentos técnicos implica títulos demasiado generales y vagos, por ejemplo:
Informe sobre la nanotecnología
Informe sobre el ébola
Informe sobre teléfonos inteligentes
Informe sobre la energía solar
Informe sobre el grafeno
Diseño y formato de la página del título
El capítulo sobre diseño de documentación técnica Presenta una idea bastante espartana de la página de título, mostrada aquí a la izquierda. Sin embargo, muchos documentos técnicos tienen hermosas imágenes incluidas en la página de título, como se muestra a la derecha:
 |
 |
Agradecería sus opiniones, reacciones y críticas respecto a este capítulo: tu respuesta—David McMurrey.
