Los mejores documentos técnicos brindan una respuesta a una pregunta que otros podrían hacer.
Estructura
Comience con una declaración de la pregunta y una descripción general de por qué es importante. Citar referencias. (Contestar múltiples preguntas relacionadas también está bien, pero asegúrese de que estén estrechamente relacionadas, o bien, escriba varios documentos).
Lo siguiente que un lector querrá saber es por qué otras soluciones o enfoques ya no respondieron la pregunta. Por lo tanto, desea proporcionar una descripción del trabajo relacionado de otros (con citas). ¿Qué hicieron otras personas? ¿Intentaron responder la misma pregunta o algo relacionado? ¿Por qué no fueron adecuados sus resultados? Citar referencias.
- Cómo publicar un trabajo de investigación de forma anónima
- ¿Está bien que un profesor no incluya el nombre de su asistente de investigación al publicar un documento, incluso si el asistente hizo todo el trabajo?
- Mi asesor de tesis de licenciatura y su equipo de investigación publicaron un documento de conferencia sobre el mismo tema que mi tesis sin siquiera decirme o preguntarme si quería que se incluyera mi nombre. ¿Cómo debo comportarme ahora?
- ¿Cuántos estudiantes de posgrado han publicado su investigación en las principales revistas como Ciencia y Naturaleza?
- ¿Cuántos estudiantes de posgrado reciben muchas publicaciones después de su primer año de posgrado?
Luego, describa sus suposiciones, diseño experimental, datos, etc. Luego, describa su solución y cómo logró encontrarla. Sea claro sobre las limitaciones y cualquier posible fuente de error experimental.
Penúltimamente, puede escribir sobre otras preguntas que surgieron, otros enfoques, implicaciones, etc.
Finalmente, repita su pregunta y la respuesta que encontró. Reconozca cualquier fuente particular de asistencia o conocimiento que no haya alcanzado el nivel de coautores.
Trampas
Estos son algunos de los problemas comunes con los documentos técnicos de nuevos autores:
- El documento describe la construcción de una “cosa” en lugar de la respuesta a una pregunta. OK, entonces construiste un programa, mecanismo o circuito, gran cosa, mucha gente construye cosas. ¿Qué hace el tuyo que otros no hacen? ¿Por qué debería importarnos?
- El documento está mal estructurado, usa mala gramática o tiene muchos errores ortográficos. Un documento que es difícil de entender puede no leerse. Esto también se aplica a los documentos demasiado largos o con muchas palabras que presentan demasiada información que no es necesaria.
- El documento no muestra una relación con otro trabajo. Los buenos resultados siempre se basan en otras cosas. Si el autor no relaciona su trabajo con resultados anteriores, (debería) hacer que el lector se pregunte si esto es duplicativo y el autor simplemente no está familiarizado con lo que ya han hecho otros.
- Plagio: no solo es una violación importante de la ética y, a veces, de la ley, una vez descubierto, arroja todo el trabajo del autor a la sombra: si el autor roba el trabajo de otra persona como propio, ¿podemos confiar en algo más “escrito”? por el mismo autor?
- Por las mismas razones que el plagio, nunca falsifique resultados o resultados. (Puedes ver lo que mi departamento publica para nuestros estudiantes: Integridad académica)
Sugerencias
- Un gráfico, diagrama o ecuación cuidadosamente elegidos suele ser mucho más claro que varios párrafos de texto descriptivo. Sin embargo, si no se hace bien, esos mismos elementos pueden confundir completamente al lector hasta el punto de abandonar el documento.
- Escriba un bosquejo del papel, primero, luego complete el bosquejo.
- Use cualquier programa de revisión ortográfica y corrector gramatical que tenga a su disposición. Arregla lo que marca como incorrecto.
- No use el sarcasmo, los insultos, el humor o la exageración en su escritura técnica: no toda su audiencia lo “entenderá”, y muchos rechazarán su escritura seria por eso. Deje esos adornos para correspondencia informal y respuestas de Quora.
Después de haber pensado en todo lo anterior. Mire algunos documentos que usted (u otros) consideran buenos ejemplos. Presta atención a cómo se abordan estos puntos. Estudiar cómo otra persona escribe un artículo (o un programa) puede darle una idea de cómo mejorar su propio trabajo.
He compilado un conjunto de enlaces y sugerencias sobre buena redacción técnica: Información para los estudiantes de posgrado de Spaf. (Esa página también tiene enlaces informativos sobre ética de la investigación, cómo hacer una propuesta de doctorado y más).
