Difusión y comunicación técnica
Un grupo de 11.° del IPVCE termina un programa en LiveCode para llevar el inventario de la bodega del barrio. Funciona de maravilla en la computadora del laboratorio. Pero el profesor guía quiere revisarlo, otro grupo quiere continuarlo y el administrador de la bodega tiene que usarlo sin ayuda. ¿Qué necesitan tener por escrito para que nadie tenga que llamar al grupo cada vez que surja una duda?
Qué documentos genera un proyecto
Un proyecto no termina cuando el prototipo funciona: termina cuando otra persona puede entenderlo, reproducirlo, mantenerlo o decidir si lo usa. Eso es la documentación técnica. Cada documento tiene un destinatario distinto, y confundirlos produce textos que no sirven a nadie.
La memoria sigue un orden lógico: de lo general a lo concreto.
Del borrador a los lectores
Un documento técnico no llega a sus lectores nada más escribirse: pasa por fases ordenadas, y en cada una alguien comprueba algo distinto.
Explica qué es la documentación técnica de un proyecto y cita tres documentos distintos que se suelen generar, indicando para cada uno a quién va dirigido.
Explica qué es la documentación técnica de un proyecto y cita tres documentos distintos que se suelen generar, indicando para cada uno a quién va dirigido.
Estas secciones de la memoria de un proyecto están desordenadas: (a) presupuesto, (b) introducción y objetivos, (c) conclusiones, (d) descripción de la solución…
Estas secciones de la memoria de un proyecto están desordenadas: (a) presupuesto, (b) introducción y objetivos, (c) conclusiones, (d) descripción de la solución adoptada, (e) análisis de alternativas, (f) bibliografía y referencias. Ordénalas de forma razonable y explica con una frase qué contiene cada una.
El esquema muestra las fases por las que pasa un documento técnico desde que se redacta hasta que llega a sus lectores, pero una de ellas está tapada. Indica qué fase…
El esquema muestra las fases por las que pasa un documento técnico desde que se redacta hasta que llega a sus lectores, pero una de ellas está tapada. Indica qué fase falta y explica qué se hace en ella.
Para el proyecto de una intersección regulada con semáforos, explica la diferencia entre la memoria técnica, el pliego de condiciones y el manual de usuario del sistema:…
Para el proyecto de una intersección regulada con semáforos, explica la diferencia entre la memoria técnica, el pliego de condiciones y el manual de usuario del sistema: qué contiene cada uno y quién lo utiliza (el constructor, la entidad que lo contrata, el equipo de mantenimiento).
Planos, croquis y figuras
El plano técnico es el documento con más consecuencias prácticas: de él se fabrica directamente la pieza.
Explica qué es un plano técnico y qué información mínima contiene su cajetín (título, escala, autor, fecha, número de plano). ¿Por qué un taller no debería fabricar…
Explica qué es un plano técnico y qué información mínima contiene su cajetín (título, escala, autor, fecha, número de plano). ¿Por qué un taller no debería fabricar nunca a partir de un plano sin cajetín?
Distingue entre croquis, boceto y plano normalizado: qué nivel de detalle y qué reglas sigue cada uno y en qué fase del proyecto se usa. ¿Cuál de los tres tiene valor…
Distingue entre croquis, boceto y plano normalizado: qué nivel de detalle y qué reglas sigue cada uno y en qué fase del proyecto se usa. ¿Cuál de los tres tiene valor contractual?
Explica por qué las figuras y tablas de una memoria se numeran y llevan un pie descriptivo, y cómo se referencian desde el texto («como muestra la figura 3»). ¿Qué debe…
Explica por qué las figuras y tablas de una memoria se numeran y llevan un pie descriptivo, y cómo se referencian desde el texto («como muestra la figura 3»). ¿Qué debe poder entenderse de una figura sin leer el texto que la acompaña?
Rigor técnico: datos, citas y normas
Una memoria se sostiene sobre datos verificables, no sobre impresiones.
Para las fuentes, se anota autor, título, año y, si es una página web, la dirección y la fecha de consulta. Por ejemplo, un artículo de EcuRed o un material de CubaEduca se citan con el título de la página, el sitio y la fecha en que lo consultaste.
En una memoria técnica aparece esta frase: «según se lee en internet, el acero aguanta mucho». Señala dos problemas de rigor técnico que tiene, reescríbela correctamente…
En una memoria técnica aparece esta frase: «según se lee en internet, el acero aguanta mucho». Señala dos problemas de rigor técnico que tiene, reescríbela correctamente con un dato razonable con unidades y explica cómo se citaría la fuente en la sección de referencias.
En un informe dispones de una tabla con $300$ medidas de temperatura y de una gráfica con su evolución diaria. Explica qué va al cuerpo del documento y qué a los anexos,…
En un informe dispones de una tabla con $300$ medidas de temperatura y de una gráfica con su evolución diaria. Explica qué va al cuerpo del documento y qué a los anexos, qué regla general decide la ubicación de cada material y por qué saturar el cuerpo con datos brutos dificulta la lectura.
Explica cómo se cita una norma técnica (por ejemplo, una NC-ISO) en las referencias de una memoria: qué datos la identifican y en qué se diferencia de citar un libro o…
Explica cómo se cita una norma técnica (por ejemplo, una NC-ISO) en las referencias de una memoria: qué datos la identifican y en qué se diferencia de citar un libro o una página web. ¿Por qué en ingeniería la fecha de la norma citada es relevante?
Registro técnico, glosario y control de versiones
El estilo de una memoria no es un detalle estético: facilita o dificulta que otra persona confíe en lo que lee.
Además, una memoria incluye un glosario (definiciones de los términos técnicos) y una lista de abreviaturas, para que cualquier lector entienda el vocabulario sin buscarlo fuera. Por ejemplo: «electroválvula: válvula que se abre o se cierra mediante una señal eléctrica»; «humectación: grado en que el suelo está mojado».
| Versión | Fecha | Autor | Descripción del cambio |
|---|---|---|---|
| 1,0 | 03/02 | Daniela | Borrador inicial |
| 1,1 | 10/02 | Alejandro | Corrige el presupuesto |
Explica para qué sirven el glosario y la lista de abreviaturas de una memoria técnica y redacta dos entradas de glosario de ejemplo para un proyecto de riego automático…
Explica para qué sirven el glosario y la lista de abreviaturas de una memoria técnica y redacta dos entradas de glosario de ejemplo para un proyecto de riego automático (por ejemplo, «electroválvula» y «humectación»).
Un documento técnico circula por varios revisores. Explica qué es el control de versiones de un documento, qué campos lleva su tabla de revisiones (versión, fecha,…
Un documento técnico circula por varios revisores. Explica qué es el control de versiones de un documento, qué campos lleva su tabla de revisiones (versión, fecha, autor, descripción del cambio) y qué riesgo hay si dos personas editan copias distintas a la vez.
Corrige el estilo de estas frases de una memoria, aplicando el registro técnico impersonal: «yo creo que la estructura aguanta de sobra», «hemos visto que la batería…
Corrige el estilo de estas frases de una memoria, aplicando el registro técnico impersonal: «yo creo que la estructura aguanta de sobra», «hemos visto que la batería dura un montón», «la pieza se hace como se explica en internet». Explica la regla que aplicas en cada corrección.
Objetivos, resumen y presentación
Documentar bien no basta si el mensaje final no llega con claridad.
La defensa oral del proyecto integrador es otra forma de difusión. Con cinco minutos, cada bloque debe tener su tiempo: problema y objetivo (1 min), solución y demostración (2 min), resultados con una cifra clave (1 min) y conclusiones (1 min). Las diapositivas deben tener poco texto, letra grande y una idea por diapositiva, porque quien escucha no puede leer y atender a la vez.
Reescribe este objetivo de proyecto para hacerlo medible y acotado: «mejorar el riego del jardín de la escuela». Formula la versión corregida con criterios claros (qué…
Reescribe este objetivo de proyecto para hacerlo medible y acotado: «mejorar el riego del jardín de la escuela». Formula la versión corregida con criterios claros (qué se construirá, para qué superficie, con qué consumo máximo de agua y en qué plazo) y explica por qué un objetivo sin métricas no se puede evaluar.
Tienes cinco minutos para defender oralmente tu proyecto de fin de curso ante un tribunal. Propón una estructura de la presentación con los tiempos de cada bloque y tres…
Tienes cinco minutos para defender oralmente tu proyecto de fin de curso ante un tribunal. Propón una estructura de la presentación con los tiempos de cada bloque y tres reglas de estilo para las diapositivas que la acompañan, justificando cada decisión.
Redacta el resumen ejecutivo (máximo diez líneas) de un proyecto de tu elección, siguiendo esta pauta: problema, solución propuesta, tecnologías empleadas, resultado…
Redacta el resumen ejecutivo (máximo diez líneas) de un proyecto de tu elección, siguiendo esta pauta: problema, solución propuesta, tecnologías empleadas, resultado obtenido y una cifra destacada. Después, justifica por qué el resumen se escribe al final aunque aparezca al principio del documento.
Vuelve al principio: el grupo de la bodega necesita una memoria para quien revise y continúe el proyecto, un manual de usuario para el administrador, planos o esquemas con su cajetín, referencias bien citadas y una tabla de versiones. Con eso, nadie depende de preguntar al grupo.