Hola,
Les comparto un texto escrito por nuestro compañero Federico Larroca que me parece un insumo interesante:
1) Cuando el documento dice: "La documentación se divide en dos partes (además de la intro y conclusiones): marco teórico y trabajo realizado durante el proyecto." me parece un corte muy grueso, que capaz más depende del tipo de tesis. En tesis con un corte experimental fuerte, yo separaría "trabajo realizado" en "diseño" y "experimentos/resultados", con igual jerarquía que marco teórico. En marco teórico asumo que incluís antecedentes/estado del arte.
En Sisem ya les damos un template muy direccionado, no van a tener mucho problema en esto.
2) Con "Los títulos deben llevar mayúscula en las palabras “importantes” no estoy de acuerdo. Tampoco me molesta, mayúscula en la primera me parece suficiente.
3) Creo que el documento exagera en relación a la ubicación de figuras, hasta [ht] creo que se puede tolerar, más de eso estoy de acuerdo que va contra la filosofía de latex.
4) No me molesta que las ecuaciones se referencien cuando están a continuación en el texto.
5) No recomiendo citar herramienta/software/equipo o integrado/chip/componente en cosas estándar. Si con el nombre/versión/numero de parte/fabricante se llega facilmente en google, para mi no vale la pena citarse. Lo que sugiero poner referencia solamente cuando es una cosa rara, o discontinuada, o no es fácil encontrar documentación, o puede dar lugar a ambigüedades. Igual comparto la fiolosofía de "ante la duda, citarlo", siempre hay tiempo para sacarlo, y podemos verlo "caso a caso".
6) No me molesta el usar las citas como sujeto de la oración. A veces me queda cómodo y lo uso.
En la guía que redactamos con Fernando Silveira en su momento para los cursos de Electrónica 1 y 2 para hacer informes [1], se mencionan algunas cosas interesantes que comento a continuación
1) Una cosa que en su momento me cambió la cabeza en relación a la redacción técnica, fue dejar de pensar en mí y empezar pensar en el "lector" a la hora de escribir. O sea elegir un público objetivo y tratar de ponerse en su lugar a la hora de leer. Uno cuando escribe lo hace para que alguien lo lea y si no somos capaces de generar un documento que sea legible por ese alguien, estamos fritos. Yo siempre propongo fijar el público objetivo de las tesis en gente que vendrá después a continuar el trabajo. Es decir estudiantes avanzados (o graduados recientes) de ingeniería eléctrica y que pueden no tener conocimientos específicos del área particular.
2) Los interesados en profundizar pueden referirse a [2] y [3]. Estas frases, sacadas totalmente de contexto, están tomadas textualmente de [3], y son muy buenas:
- Escribir es un buen método para aprender
- La única manera de aprender a escribir es, en primer lugar, leer, estudiar buenos modelos, y practicar.
- Hay que capturar el interés del lector y mantenerlo a través de todo el trabajo.
- ¿Está seguro de que los únicos lectores serán los docentes? Muchas veces ocurre que los informes derivan a otros públicos, más aún si están en medio electrónicos. Esos lectores pueden ser otro estudiantes, otros profesores, profesionales externos al medio académico, eventualmente futuros empleadores.
- Trate de conseguir al menos un revisor
- Elimine verborragia. Si se puede expresar en forma corta y simple ¿por qué no hacerlo?
- Las expresiones que implican largas oraciones, donde las ideas se mezclan confunden al lector. Regla básica: Una sola idea por oración.
- Evitar ser ambiguo. Afirmaciones del estilo "el ensayo del control del freno del automóvil muestra que éste es inestable a altas velocidades" hacen dudar al lector sobre lo que se está diciendo. ¿Cuál es la parte inestable, el sistema de control, el freno o el automóvil?
- Sea breve, cada vez que su lector tiene que dar vuelta la página, usted corre el riesgo de perderlo.
- Debemos recordar las reglas ortográficas y analizar permanentemente el uso apropiado de ellas.
- Todas las tablas y figuras debe estar referidas en el texto escrito.
- No abuse de las figuras.
- Las figuras deben ser comprensibles en sí mismas. Si se trata de gráficos, es obligatorio rotular los ejes y colocarles las escalas correspondientes con los valores y unidades apropiados.
[1] https://eva.fing.edu.uy/mod/resource/view.php?id=31728
[2] http://writing.colostate.edu/guides/documents/ce-trpt/
[3] "Guía sobre Redacción Técnica" de Daniel Slomovitz, Montevideo, Trilce, 2007. Es corto y muy ameno de leer, pasa unos cuantos piques bien interesantes. Está en la biblioteca del IIE, en la central o se puede comprar (su precio es era muy razonable).
Saludos,
Julián