Consejos sobre Documentos Técnicos Redacción

La comunicación es un componente crucial de cualquier disciplina. Tanto si usted pasa sus días el diseño de protocolos informáticos , la elaboración de nuevas aplicaciones de ingeniería o el desarrollo de nuevas técnicas quirúrgicas , en algún momento tendrá que presentar sus conclusiones al mundo en general. Ya sea que usted se está preparando un documento para presentar en una conferencia, a someterse a un diario, o simplemente para cumplir con los requisitos de la Física 410, algunos consejos generales pueden hacer que su papel se destacan. Organización

documentos técnicos siguen un formato bastante estándar . Vas a tener un título, resumen , introducción, cuerpo , conclusiones , recomendaciones para el trabajo futuro , anexos , apéndices y una bibliografía. Cada sección tiene sus propias dificultades particulares.

• Utilice un título que indique claramente el tema de su papel.

• Su resumen debe ser a la vez breve y completa .

• Su introducción debe explicar su problema; razón por la que merece la exploración, por lo que no ha sido resuelto antes, y los puntos principales de su investigación.

• Siempre es importante describir otras investigaciones pertinentes .

• Si es necesario, incluya una sección de " Preliminares " para introducir al lector en términos que no conoce , definiciones o anotaciones .

• Asegúrese de que el cuerpo de su trabajo sigue una narrativa clara y concisa.

• Su conclusión debe ser un breve resumen de sus hallazgos.

• Incluye una sección sobre la investigación futura , ya sea para describir sus propios planes de trabajo , o para inspirar a otros en busca de nuevas direcciones.

• Reserva apéndices de la información técnica que alguien podría resultar interesante , pero no es necesario que el lector a comprender su trabajo.
claridad

escritura técnica exige claridad. Su audiencia debe ser capaz de entender lo que quieres decir , en la manera exacta que usted quiere decir. Para asegurar que esto suceda , utilice estructuras de oraciones simples siempre que sea posible , especialmente cuando usted está tratando de describir los procesos complicados. ¿Es posible que una sentencia podría ser malinterpretado ? Si es así, volver a escribirlo . Proporcionar cifras , gráficas y ecuaciones, tanto para ilustrar sus conclusiones y para comunicarse efectivamente con los que piensan visualmente . Asegúrese de que su narración sigue siendo lineal , que cada paso sigue al anterior en un orden lógico , por lo que su conclusión parece inevitable. Cuando haya terminado de escribir, poner su papel fuera por un día o dos , luego se lo quita de corregir . Si es posible , haga que algunos " lectores beta " lean y critiquen su trabajo.
Concisión

Vaya al grano con sencillez y claridad . Puede ser útil recordar el punto de la redacción técnica : usted está escribiendo para informar, en lugar de entretener. Cuando usted está explicando su motivación para crear un nuevo tipo de malla de hernia, no se sienta obligado a dar un mini- repaso sobre los tipos de hernia; su público lo sabe. Del mismo modo , al introducir el nuevo protocolo de motores de búsqueda , no divagar en una historia de la computadora . Se puede ayudar a perfilar su trabajo antes de empezar a escribir. Sólo tiene que rellenar un punto y , a continuación, pasar a la siguiente. Su papel será más corto , más fácil de escribir, leer y de entender.
Relaciones Humanas

comunicación siempre tiene un componente humano , y hay errores que harías así para evitar . En primer lugar, asegúrese de seguir las directrices proporcionadas por el comité , conferencia o profesor . Al citar el trabajo de otros , asegúrese de que lo hace con precisión; no leer en ella , encontrando una conclusión que no está realmente allí . Si tiene que criticar el trabajo de otro , que lo hagan de manera constructiva y con la consideración . Y , si bien puede parecer calculado , incluir (y leer) las investigaciones pertinentes realizadas por los de su panel de la conferencia , o publicados en la revista a la que vas a enviar . Por último , asegúrese de que su investigación y su escritura son originales. No le dé a la autoría de crédito a alguien que no ha contribuido al contenido intelectual de su trabajo, y no buscan en el trabajo de otro si no has ganado. Comunidades académicas y científicas son pequeñas y tienen buena memoria . Si usted desea tener éxito en ellos, tratar a sus colegas con respeto.